Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Welcome to Cython's documentation

The current Cython documentation is hosted at 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

pip install -r doc-requirements.txt

To build the documentation go into docs folder and run

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.

Notes
  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