# activate python virtual env
path/to/venv/bin/activate
# activate node
nvm use v6.9
# run bash script for building
./auto_build.sh
# activate python virtual env
path/to/venv/bin/activate
# activate node
nvm use v6.9
# extract doc strings from source
python extract_doc_strings.py
# run build script
cd src/javascript/docgen
node generate_docs.js
# build doc using sphinx
make html
snippets
- edit "file_list" array in "extract_doc_strings.py" to ensure parsing of doc strings from source into doc string files
- comment format:
// COMMENT_NAME: default-serialize...// COMMENT_END - comment produces file under comments directory named after COMMENT_NAME
- add literalinclude to rst file(s) appropriatly to bring whole comment file in
auto-gen doc
- edit the "writeDoc(...)" lines in the "generate_docs.js" to ensure auto-extracted doc strings get into doc
- see any of these files for examples of JSdoc comment syntax
- see JSDoc standards for formatting of these comments
- http://usejsdoc.org/
- https://github.com/jsdoc2md/jsdoc-to-markdown
updating read-the-docs
- git commit -am "msg about the update"
- git push
- read-the-docs is will auto-syc with this repo on github