This is the documentation for the Branchdoc. You can find the resulting GitHub Pages in here
Used 3rd party libraries which are not part of the standard Python package:
- Sphinx - Powerful documentation generator that has many great features for writing technical documentation - BSD-2 License
- sphinx-rtd-theme - Read the Docs theme for Sphinx. - MIT License
- sphinx-rtd-dark-mode - Adds a toggleable dark mode to the Read the Docs theme for Sphinx. - MIT License
- sphinxcontrib-mermaid - Mermaid diagrams in yours sphinx powered docs. - BSD-2 License
- sphinx-copybutton - Add a "copy" button to code blocks in Sphinx. - MIT License
- sphinx-togglebutton - Show and hide content with a button in Sphinx. - MIT License
- myst-parser - An extended commonmark compliant parser, with bridges to docutils/sphinx. - MIT License
- mermaid-js/mermaid-cli - Command line tool for the Mermaid library. - MIT License
If you have further ideas or you found some bugs, great! Create an issue or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
The whole source code is published under BSD-3-Clause. Consider the different licenses of the used third party libraries too!
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.