Mkdocs PR 31 suggestions #1
Closed
Conversation
This file contains 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
- mkdocs pulls in ~75 deps on top of dev's ~25 so separate them to try to avoid dependency issues.
lindsay-stevens
force-pushed
the
mkdocs-2
branch
from
d2fdbb6 to
f10b81e
Compare
4 tasks
lindsay-stevens
force-pushed
the
mkdocs-2
branch
from
f10b81e to
dae0e16
Compare
- explicitly name the docs pages to try to make it clearer that forms/subs/projs
are attributes of the Client. As main sections they seem like they're separate
classes or topics. Nesting these into a collapsible section seems unnecessary
because currently they are a main purpose of the documentation.
- move the header documentation in projects, forms, submissions into the classes
since it is useful info for docstrings to have.
- while it may be possible to use a script to avoid having the remaining stub
files with autodoc instructions, it seems unnecessary for only 4 files.
- add docstrings for Client.open / close so that they show up in the docs.
- README:
- fix indentation of the Client methods list, it didn't render properly.
- add section on "Errors raised by pyODK".
- remove relative links to Examples library for now because it won't work
on both GitHub and rendered docs - replace later with links to the published docs.
- move README.md in project root, so it is in the most obvious place.
- add explicit mkdocs "watch" item to ensure README changes trigger reload.
- add "index.md" with a snippet instruction, to copy over the README content.
- add ODK logo
- svg minimised: removing some raster shadowing around the border cuts the
file size from 128KB to 2KB. Imperceptible difference at the size it's rendered
at, particularly with a dark background.
- add basic light/dark mode.
- add repo url/name to link to GitHub
- sort the theme/features and mkdocstrings/options dicts for legibility.
lindsay-stevens
force-pushed
the
mkdocs-2
branch
from
dae0e16 to
c65ca01
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Detail in commit messages