blob: b18c53a3b54c1a764d3efec19f66d6593ad9ea7e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# Welcome to Cython's documentation
The current Cython documentation is hosted at [cython.readthedocs.io](https://cython.readthedocs.io/)
The main documentation files are located in the `cython/docs/src` folder and the code that is used in those documents is located in the `cython/docs/examples`
Before building, you need to install `doc-requirements.txt` (and `make` on Linux).
To install `doc-requirements.txt` run in the root folder
```shell
pip install -r doc-requirements.txt
```
To build the documentation go into `docs` folder and run
```shell
make html
```
You can then see the documentation by opening `cython/docs/build/html/index.html` in a browser.
Generally follow the structure of the existing documents.
If you are creating a (sub)section add a link for it in the TOC of the page.
<details>
<summary>Notes</summary>
1) Some css work should definitely be done.
2) Use local 'top-of-page' contents rather than the sidebar, imo.
3) Fix cython highlighter for cdef blocks
</details>
|
