-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use Quarto / Quartodoc for documentation #421
Conversation
To avoid explicitly specifying all members explicitly on aliases we need this PR machow/quartodoc#327 We prefer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for all the hard work converting our docs to quartodoc!
Earlier this year, I worked quite a lot on the API documentation - including "header" information on most of the subpages - see e.g. https://dhi.github.io/modelskill/api/comparer/ or https://dhi.github.io/modelskill/api/model/ which has general information about the structure with links to important methods etc. These pages are now gone - I think that is a pity - not just because I spend time writing them but also because I found that useful.
- Could you please re-introduce the overview pages in the API docs - especially for ModelResult, Observation, Matching, Comparer?
- Could you please remove the API sub-headings (in the left hand side nav bar) for Plotting, Metrics, Quantity and Settings - it is annoying that you need to expand a subsection with only one element.
- Change headline of API reference to "API reference" instead of "Function reference"
- I would suggest to remove the plot on the frontpage of the documentation as I think it is more clean and nice without - but I am flexible here :-)
|
quartodoc
is different frommkdocsstrings