README 667 Bytes
Newer Older
1
Welcome to Cython's documentation.
2

3
To build the documentation on Linux, you need Make and Sphinx installed on your system. Then execute::
4 5 6

	make html

7
On windows systems, you only need Sphinx. Open PowerShell and type::
8 9 10 11

	./make.bat html

You can then see the documentation by opening in a browser ``cython/docs/build/html/index.html``.
12

13
The current Cython documentation files are hosted at
Josiah Carlson's avatar
Josiah Carlson committed
14
https://cython.readthedocs.io/en/latest/
15 16


Peter Alexander's avatar
Peter Alexander committed
17 18
Notes
=======
19

20
1) Some css work should definitely be done.
21 22
2) Use local 'top-of-page' contents rather than the sidebar, imo.
3) Provide a link from each (sub)section to the TOC of the page.
Peter Alexander's avatar
Peter Alexander committed
23
4) Fix cython highlighter for cdef blocks