diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..b18c53a3b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,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> |