Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete rewrite of documentation, moving from Sphinx to mkdocs #266

Merged
merged 4 commits into from
Sep 15, 2024

Conversation

lonvia
Copy link
Member

@lonvia lonvia commented Sep 15, 2024

Drops Sphinx in favour of mkdocs for generating the documentation. Needs mkdocs, mkdocs-material, mkdocstrings and mkdocstrings-python packages for generation.

The documentation itself also has seen a major overhaul:

  • The user manual is heavily extended and mostly focusing on the new iterative way of reading data.
  • There are a couple of cookbooks which are written in the form of Jupyter notebooks.
  • The code documentation for the C++ bindings has moved to the .pyi type files, which makes it easier to read and edit. mkdocstrings is also much better in generating docs from the Python type files than from the docstrings generated by pybind11.

@lonvia lonvia merged commit 9809288 into osmcode:master Sep 15, 2024
21 checks passed
@lonvia lonvia deleted the new-docs branch September 15, 2024 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant