TopoPyScale_Documentation

Documentation of the TopoPyScale toolbox. https://topopyscale.readthedocs.io

S. Filhol, J. Fiddes, January 2022

Contributing to the Documentation

The documentation is written in Markdown with the tool https://www.mkdocs.org

1. Create a local Python VE

   conda create -n rtdoc
   conda activate rtdoc
   pip install mkdocs sphinx_rtd_theme mkdocs-material pygments
   
   # cloning using SSH key
   git clone git@github.com:ArcticSnow/TopoPyScale_Documentation.git
   cd TopoPyScale_Documenation

2. Modify a given file or create a new one. If you create a new one add it to mkdocs.yml

3. run mkdocs serve to visualize the modification on your local machine

4. open the URL: http://127.0.0.1:8000/ in your browser

For customization of the theme, please use the documentation https://squidfunk.github.io/mkdocs-material/. All custom parameters are in the file mkdocs.yml

Update the API documentation

Run this command from the TopoPyScale virtual environment with correct paths:

lazydocs --output-path="path/to/TopoPyScale_Documentation/docs" --overview-file="README.md" --src-base-url="https://github.com/ArcticSnow/TopoPyScale" path/to/TopoPyScale