Project to practice documentation for C++ and Python
This project is based on several documents available online. Please check Resources for a list.
The result is available at:
https://umedalab.github.io/practice-DocumentationCPPPython/
Clone or download the project.
Recommended: Create a virtual environment and install the sphinx package.
python -m venv env
Windows:
env\Source\activate.bat
Linux:
source env\bin\activate
Install Doxygen
https://www.doxygen.nl/download.html
Add to the environment path the location of the doxygen binary (i.e. C:/Program Files/Doxygen/bin).
pip install -U Sphinx
pip install sphinx-rtd-theme
pip install breathe
In github, remember to set GitHub pages in Setting. The best solution is to wait until the new branch "gh-pages" is created and set the correct brench.
The link to the website will be provided.
This project does not requires installation.
- Empty :)
This project differs form the original documentation in how the folders are structured.
It also modifies the file "github\workflows\docs.yml".
NB: ssh.yml targets a project not found. The code is kept for reference.
All contributions are welcome :).
The project uses semantic versioning.
https://semver.org/
Version 0.1.0
- Khoronus - Initial work - Khoronus
This project is licensed under (see the LICENSE.md file for details).
- Empty :)
https://medium.com/practical-coding/c-documentation-with-doxygen-cmake-sphinx-breathe-for-those-of-use-who-are-totally-lost-7d555386fe13
https://medium.com/practical-coding/c-documentation-with-doxygen-cmake-sphinx-breathe-for-those-of-use-who-are-totally-lost-part-2-21f4fb1abd9f
https://medium.com/practical-coding/c-documentation-with-doxygen-cmake-sphinx-breathe-for-those-of-use-who-are-totally-lost-part-3-d20549d3b01f
https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
https://google.github.io/styleguide/pyguide.html
https://github.com/KhoronusFork/cpp_doxygen_sphinx
https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions