Nen Sack voll documentation improvements #82
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
|
note that a preview is best obtained from a local webserver, reading over |
funkyfuture
force-pushed
the
docs
branch
4 times, most recently
from
cf03e1e
to
c0e0696
Compare
Merged
the :meta category: docstring tags are kept though until there's no hope for a re-use left.
thus it replaces autoclasstoc. the actual categories still need to be adjusted in the docstrings, but this is deferred to simplify rebasing upon a currently unmerged PR.
Unless its contents grow, it should eventually be dissolved.
this adds the sphinx-design extension to the zoo.
and renames showdocs to show-docs
as a result unnecessary intersphinx prefixes are removed. that's collision prone, but i don't assume further included inventories and name collisions with Python are a no-no.
the latter shall be in that order: - descriptive summary - fields - prose
It was motivated to create targets for then hyperlinking type annotations in the API docs. Turns out the second part doesn't work yet. I assume that better practices around type documentation will evolve. And it's still a usable reference that ranks high in searches.
|
shouldnt readthedocs be instructed to use a more recent python version? |
funkyfuture
commented
Jan 23, 2024
funkyfuture
commented
Jan 23, 2024
Co-authored-by: Frank Sachsenheim <[email protected]>
|
i still would love to go through these properly, as it has been years since the last time i used sphinx. i'll approve regardlesz so you this doesnt collect dust while i try to get around to doing that. |
JKatzwinkel
approved these changes
Jan 24, 2024
|
i merged the changes here and new graphics for the design chapter manually. |
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.
a great way to procrastinate implementing important parts is to finally overhaul the docs.
mainly triggered by autoclasstoc being essential imo (iits functionality) and kaputt. i also finally ruled out the sphinx-immaterial theme which is more incomplete than one might think. and as i found autodocsumm as replacement for autoclasstoc which is seemingly coded clean enough to adapt to future Sphinx changes i could opt for furo, hossa!
this is left to do:
mainafter Removes deprecated code #80 was merged:meta category:tags, e.g.add-nodes->Adding nodesFilter,NodeBase,NodeSourceand_TagDefinitioninto the API docs with an explanatory prose, but no memberstuplemethods fromNamedTuplesubclasses, eg.xpath.EvaluationContextutils.get_traverservanished, analyze the error and fix it[ ] i'd love to create prettier tree visualizations for the Design document but haven't found anything suitable that processes text input yetpostponed