-
Notifications
You must be signed in to change notification settings - Fork 18
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
feat(template): quarto documentation engine #257
feat(template): quarto documentation engine #257
Conversation
@Anavelyz , could you rebase your branch please? |
@@ -47,9 +52,11 @@ groups: | |||
{%- if cookiecutter.documentation_engine == "jupyter-book" %} | |||
cd docs/_build/html/ && python -m http.server | |||
{%- elif cookiecutter.documentation_engine == "mkdocs" %} | |||
mkdocs build --config-file mkdocs.yaml | |||
mkdocs serve --watch docs --config-file mkdocs.yaml |
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.
good catch! thanks
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.
@Anavelyz , it looks good to me.
please rebase your branch on top of the upstream/main, and it will be ready to go :)
b67b7a4
to
6f5dc85
Compare
🎉 This PR is included in version 0.8.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Pull Request description
Adding quarto to documentation engine options.
Edited files:
Added files:
Note: Fixed an issue with the mkdocs configuration in src/scicookie/{{cookiecutter.project_slug}}/.makim.yaml and added permissions to the cli.sh file
Other details: To implement the API documentation, quartodoc was used, this library requires python >= 3.9, for this reason the condition here was added.
Fixes #172
Fixes #175
Pull Request checklists
This PR is a:
About this PR:
Author's checklist:
complexity.
Reviewer's Checklist
main
branch