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.

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

Merged
merged 5 commits into from
Apr 3, 2024

Conversation

Anavelyz
Copy link
Collaborator

@Anavelyz Anavelyz commented Apr 1, 2024

Pull Request description

Adding quarto to documentation engine options.

Edited files:

  • src/scicookie/cookiecutter.json
  • src/scicookie/profiles/base.yaml
  • src/scicookie/hooks/post_gen_project.py
  • src/scicookie/{{cookiecutter.project_slug}}/.makim.yaml
  • src/scicookie/{{cookiecutter.project_slug}}/Makefile
  • tests/smoke/docs.sh
  • The pyptoject.toml for different build-system.

Added files:

  • src/scicookie/{{cookiecutter.project_slug}}/docs-quarto/_quarto.yml
  • src/scicookie/{{cookiecutter.project_slug}}/docs-quarto/styles.css

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:

  • bug-fix
  • new feature
  • maintenance

About this PR:

  • it includes tests.
  • the tests are executed on CI.
  • the tests generate log file(s) (path).
  • pre-commit hooks were executed locally.
  • this PR requires a project documentation update.

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.
  • The code is well commented, especially in the parts that contain more
    complexity.
  • New and old tests passed locally.

Reviewer's Checklist

  • I managed to reproduce the problem locally from the main branch
  • I managed to test the new changes locally
  • I confirm that the issues mentioned were fixed/resolved

@Anavelyz Anavelyz marked this pull request as ready for review April 1, 2024 20:26
@Anavelyz Anavelyz requested a review from xmnlab April 1, 2024 20:34
@xmnlab
Copy link
Member

xmnlab commented Apr 2, 2024

@Anavelyz , could you rebase your branch please?
sorry, my bad for taking too much time for merge your other PR XD

@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch! thanks

Copy link
Member

@xmnlab xmnlab left a 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 :)

@Anavelyz Anavelyz force-pushed the 172-quarto-documentation-engine branch from b67b7a4 to 6f5dc85 Compare April 3, 2024 14:22
@xmnlab xmnlab merged commit 9aed15b into osl-incubator:main Apr 3, 2024
12 checks passed
@Anavelyz Anavelyz deleted the 172-quarto-documentation-engine branch April 3, 2024 16:00
Copy link

github-actions bot commented May 3, 2024

🎉 This PR is included in version 0.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants