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.
Summary of changes
Hi @nicholascar @ajnelson-nist, as discussed in #3128 I migrated the documentation from rst format with sphinx, to markdown with mkdocs (material for mkdocs)
Migrated all
.rst
pages to.md
. I merged the 5 plugins pages in 1 (all pages were small ~50 lines, it's easier to maintain and read to have them all in one page, without being overwhelming), we can also put it back as 5 different pages if required.Migrated all docstrings to markdown with google style, generated API references docs using
mkdocstring
e.g.All doctests are working and passing, they just required to add an extra newline before the ending ```
I have previously mentioned I was planning to look into alternatives for running markdown codeblocks, e.g. using
pytest-markdown-docs
. Introducing tests on the markdown codeblocks would require a lot of changes to the documentation, there are already enough.I chose indigo for the primary color because it is one of the few colors that constrats well with the green and yellow of the logo, and it is close to the background of the original semantic web logo
Website splits in 3 top nav: Usage, API Reference, Development. With the pages in the current section listed on the left
Updated the
.readthedocs.yaml
config according to their docs, removed sphinx from dependencies and updated most build scriptsYou can easily start it locally with:
I have included screenshots of the website, let me know if there is anything that needs to be done
Checklist
the same change.
./examples
.so maintainers can fix minor issues and keep your PR up to date.