Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Use Quarto / Quartodoc for documentation #421

Open
wants to merge 43 commits into
base: main
Choose a base branch
from
Open

Use Quarto / Quartodoc for documentation #421

wants to merge 43 commits into from

Conversation

ecomodeller
Copy link
Member

@ecomodeller ecomodeller commented Feb 14, 2024 •
edited

  • ➕ Notebooks are rendered nicely
  • ❓ quartodoc is different from mkdocsstrings
  • ➕ Executable docstring examples, including figures and tables as output

image

@ecomodeller
Copy link
Member Author

To avoid explicitly specifying all members explicitly on aliases we need this PR machow/quartodoc#327

We prefer PointModelResult instead of model.point.PointModelResult (the location in file system should be irrelevant to the user).

@ecomodeller ecomodeller changed the title Experiment to use Quarto / Quartodoc for documentation Use Quarto / Quartodoc for documentation Feb 20, 2024
@ecomodeller ecomodeller marked this pull request as ready for review April 9, 2024 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@ecomodeller @jsmariegaard