56 lines
1.3 KiB
Plaintext
56 lines
1.3 KiB
Plaintext
|
|
|
|
nim cc \
|
|
-d:release \
|
|
--stackTrace:off \
|
|
--lineTrace:off \
|
|
--checks:off \
|
|
--assertions:off \
|
|
--debugger:native \
|
|
joy.nim
|
|
|
|
nim doc --project --index:on --git.url:"https://git.sr.ht/~sforman/Bliss" --git.commit:10b5651ed242fb16c29f2c1f7340d77f65926ca4 --outdir:htmldocs joy.nim
|
|
|
|
https://git.sr.ht/~sforman/Bliss/tree/10b5651ed242fb16c29f2c1f7340d77f65926ca4/item/types.nim#L26
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
§.3.1 Jupyter Notebooks
|
|
|
|
The docs/ folder contains Jupyter notebooks, ... TODO
|
|
|
|
§.3.2 Sphinx Docs
|
|
|
|
Some of the documentation is in the form of ReST files
|
|
|
|
§.3.3 Building the Docs
|
|
|
|
Building the documentation is a little tricky at the moment. It involves
|
|
a makefile that uses nbconvert to generate ReST files from some of the
|
|
notebooks, copies those to the sphinx source dir, then builds the HTML
|
|
output using sphinx.
|
|
|
|
Get the dependencies for (re)building the docs:
|
|
|
|
pip install Thun[build-docs]
|
|
make docs
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Nothing is done about Python exceptions currently, although it would be
|
|
possible to capture the stack and expression just before the exception
|
|
and build a robust and flexible error handler. Because they are both
|
|
just datastructures, you could immediately retry them under a debugger,
|
|
or edit either or both of the stack and expression. All state is in one
|
|
or the other.
|
|
|
|
|