Port documentation from Readthedocs to docstrings + Documenter #100
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
Evizero
changed the title
|
Ok, this should do it. |
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.
I have dreaded this for a long time, but I think 1.0 is a good enough reason to bite in the sour apple.
This moves all the function-signature (and type) documentation into docstrings and ports all the other
rsttext to markdown.With a bit of css magick i was even able to hide the ASCII plots and docstring formulas from the online docs of the individual losses. Thus more or less reproducing the old look with the table of figures+formulas
TODO