This repository contains the functional documentation for the Generic Functions. The documentation is built using Sphinx.
This repository sole purpose is to describe the functionality, structure, and interaction patterns of the Generic Functions Modules.
Please note, this content:
- Is for informational and internal reference purposes.
- May not reflect finalized designs or decisions.
- May be updated or restructured without notice.
- May contain errors, omissions, or oversimplified implementations
By using or referencing this code or documentation, you acknowledge that you do so at your own risk and that the authors assume no liability for any consequences of its use.
- Make
- Docker (with Sphinx and Python)
-
Download the latest version of the Rijkshuisstijl Sphinx theme.
For this, you need to have the GitHub CLI installed and authenticated. See GitHub CLI documentation for installation instructions.
gh release download --clobber -D docs/ --repo minvws/icore-manon-sphinx-theme --pattern 'sphinx-rijkshuisstijl*.zip' -
Compile and generate the documentation locally
It will start the local live server and watch for changes in the source files.
make dev
If you want to build the documentation without starting a live server, you can run:
make all
This project's sole purpose is to provide documentation for the Generic Functions.
For that reason, we will only accept contributions that fit this goal. We do appreciate any effort from the community, but because our time is limited, it is possible that your PR or issue is closed without a full justification.
If you plan to make non-trivial changes, we recommend opening an issue beforehand where we can discuss your planned changes. This increases the chance that we might be able to use your contribution (or it avoids doing work if there are reasons why we wouldn't be able to use it).
Note that all commits should be signed using a GPG key.