Doc-tracing
Repository dedicated to the talks about pydoctrace. It is a mix of English and French talks.
Slideshows
-
2023.06.29-BreizhCamp-doc-tracing_quicky_fr.adoc, quicky given during of the BreizhCamp 2023 edition (Brittany, France, 🇫🇷French contents). Pdf version: 2023.06.29-BreizhCamp-doc-tracing_quicky_fr.pdf.
-
2023.04.06-doc-tracing_quicky_fr.adoc, quicky given during the Evening with the technical communities of Rennes (Brittany, France, 🇫🇷French contents). Pdf version: 2023.04.06-doc-tracing_quicky_fr.pdf.
View the slideshows
The slideshows were designed to be displayed using the flobilosaurus.vscode-asciidoc-slides extension for Codium / vsCode.
-
display the commands with
ctrl shift p
-
use the
Asciidoc Slides: Open Slides in Browser
command
Documentation about the Asciidoc syntax for slideshows.
Export as a PDF file
-
use the
Asciidoc Slides: Export document as PDF
command (it does not always work)
or :
-
open the slideshow with chromium or chrome
-
add
?print-pdf
at the end of the URL -
print as a PDF with
ctrl p
oucmd p
Code examples
This repository involves code samples (see examples folder) and libraries which generate documentation:
# installs the appropriate python version (any 3.10+ should be ok)
pyenv install $(cat .python-version)
# creates a virtual environment
python - m venv .venv
# activates the virtual environment
source .venv/bin/activate
# installs the libraries
pip install -r requirements.txt
cd examples
python -m pydoc -p 8080 -b