Updates¶
The PyLit documentation itself is built with Sphinx. It includes the text version of several modules.
Here’s the test procedure. Note the cd
to change directories. This
assures that PyLit is found in the ..
directory.
cd test
python3 pylit_test.py
python3 pylit_ui_test.py
You can also use tox to run a suite of tests.
tox
Here’s part of the documentation build procedure. It uses PyLit to create source for the documentation.
- Clone a new document from
docs/index.txt
- Clone a new example from a file in
docs/examples
- Clone a new example from a file in
test
python3 pylit.py docs/conf.py
python3 pylit.py pylit.py docs/examples/pylit.py.txt
python3 pylit.py --comment-string='## ' test/pylit_test.py docs/examples/pylit_test.py.txt
After this, we can manually run Sphinx to rebuild the documentation.
sphinx-build docs _build/html
We can do this wih the included Makefile, which also converts all of the tutorials and examples.