To contribute, edit the *.md files within the docs folder. Then execute the following from within the /Python/docs folder:
sphinx-build . _buildTo autobuild and see changes in real time:
sphinx-autobuild . _buildThen go to http://127.0.0.1:8000/.
To run notebooks, execute the following from the ./Python/docs/vignettes directory:
jupyter notebookTo build vignettes, execute the following from the ./Python/docs/vignettes directory:
jupyter nbconvert cocaine.ipynb --to markdown
jupyter nbconvert prostate.ipynb --to markdown
jupyter nbconvert titanic.ipynb --to markdownWorkflow for updating documenation:
- Make any changes to the Python docstrings.
- Then execute the following from the
./Pythondirectory:
pip uninstall easymlpy -y
python setup.py install
sphinx-build ./docs ./docs/_build
sphinx-autobuild ./docs ./docs/_buildThen go to http://127.0.0.1:8000/ to view the documentation.