Mkdocs #271
Merged
Mkdocs #271
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
For building docs, we use Cython 3.0 now, which automatically provides full introspection functionality for cython functions
|
Looks good! I've added a PR that enables |
|
Initially wanted to use the As for the binding: With Cython >= 3 we don't need to configure anything specific, as binding is enabled globally by default in Cython 3. |
20 tasks
|
Looks good to me. The docstrings should Just Work because you're enforcing Cython 3 in the doc requirements. |
tazend
added a commit
that referenced
this pull request
May 14, 2023
* 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on #268
@multimeric
Alright, you should be able to run
scripts/builddocs.shandmkdocs serveto check out the rendered docs from compiling with Cython 3