The documentation is written in reStructuredText format and can be build with Sphinx documentation generator. Alternatively, MyST, a Markdown flavor, can be used as well.
It is recommended to install Python dependencies in virtual environment.
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ pip3 install -r requirements.txtWhen finished working inside the virtual environment you can step out of it:
(.venv) $ deactivateTo build the project you need to be in the virtual environment.
(.venv) $ make htmlSome changes may require a full project rebuild as documents are usually linked to each other:
(.venv) $ make clean && make html$ firefox _build/html/index.htmlYou do not need to be in virtual environment to see the build result.
- Create a new page in reStructuredText or Markdown formats and include it somewhere in src folder.
- Every new page needs to be part of a page table of content (ToC) tree. To
add a page to the ToC tree, either include it in
toctreedirective in an existing document or add it to the top level navigation at the end of the [index] document. - Build the documentation with
make htmland navigate to your page to check that everything is displayed as intended. - Open a Pull Request against this repository with your change.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent