docs: add an index and move the docstrings to a reference page #113
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.
One disadvantage of using Autodocs now is that the nice, easy-to-navigate list of names in the left sidebar that's in the stable docs, is no longer there in the dev docs.
This PR uses Documenter's
@index
feature to generate an index of names as a replacement. I also moved the (@autodoc
-ed) docstrings to a separate reference page, since it looks nicer to have just a quick list of functions at a glance in the homepage, instead of showing the intimidating full listing of docstrings right away.