Skip to content

Commit f3dbb73

Browse files
tazendmultimeric
andauthored
Transition from sphinx to mkdocs for documentation (#271)
* Transition from sphinx to mkdocs for documentation * Tidy up docstrings, mkdocs config * Add logo to docs, hide navbar * Reformat docstring indentation * Missing newline * Fix more wrong indents * Add `mike` for versioning the docs * add site dir to gitignore * setup.py: Remove .so files on cleanup * header.pxi: Rename all "cpdef enum" to "cdef enum" cpdef didn't work correctly with Cython 3.0 onwards, which is needed for the docs. Setting this to "cdef enum" doesn't change any functionality in our case. * Remove embedsignature=True For building docs, we use Cython 3.0 now, which automatically provides full introspection functionality for cython functions * Build docs with Cython 3.0 --------- Co-authored-by: Michael Milton <michael.r.milton@gmail.com> Co-authored-by: Michael Milton <ttmigueltt@gmail.com>
1 parent dd73ddf commit f3dbb73

File tree

16 files changed

+606
-833
lines changed

16 files changed

+606
-833
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Ignore Build Directory #
22
build/
3+
site
34

45
# Ignore Docs Directory #
56
#doc/

doc/Makefile

Lines changed: 0 additions & 130 deletions
This file was deleted.

doc/doctrees/environment.pickle

-964 KB
Binary file not shown.

doc/doctrees/index.doctree

-7.6 KB
Binary file not shown.

doc/source/conf.py

Lines changed: 0 additions & 233 deletions
This file was deleted.

0 commit comments

Comments
 (0)