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

add quarto script to create qmd from docstring, issue #132 #146

Merged
merged 3 commits into from
Jan 25, 2025

Conversation

artiom-matvei
Copy link
Contributor

@artiom-matvei artiom-matvei commented Jan 11, 2025

Procedure to create qmd files from the documentation in the python files

See _quarto.yml for detailed documentation.

In short, the procedure is as follows:

  1. Install quartodoc with uv pip install quartodoc
  2. Launch quartodoc build
  3. The qmd files will be in the folder qmd_files

See _quarto.yml for detailed and up-to-date how-to.

issue #132

@artiom-matvei artiom-matvei changed the title add quarto script to create qmd from docstring add quarto script to create qmd from docstring, issue #132 Jan 11, 2025
@artiom-matvei artiom-matvei force-pushed the quarto_doc branch 3 times, most recently from 200a5de to 3c2fbf0 Compare January 25, 2025 21:40
@artiom-matvei artiom-matvei marked this pull request as ready for review January 25, 2025 21:54
@vincentarelbundock vincentarelbundock merged commit e5f1fa2 into vincentarelbundock:main Jan 25, 2025
5 checks passed
@vincentarelbundock
Copy link
Owner

Thanks a lot. Merged

@artiom-matvei artiom-matvei deleted the quarto_doc branch January 26, 2025 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants