Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

Documentation

To contribute, edit the *.md files within the docs folder. Then execute the following from within the /Python/docs folder:

sphinx-build . _build

To autobuild and see changes in real time:

sphinx-autobuild . _build

Then go to http://127.0.0.1:8000/.

To run notebooks, execute the following from the ./Python/docs/vignettes directory:

jupyter notebook

To 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 markdown

Workflow for updating documenation:

  1. Make any changes to the Python docstrings.
  2. Then execute the following from the ./Python directory:
pip uninstall easymlpy -y
python setup.py install
sphinx-build ./docs ./docs/_build
sphinx-autobuild ./docs ./docs/_build

Then go to http://127.0.0.1:8000/ to view the documentation.