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 docs for how to document only Python files #321

Merged
merged 2 commits into from
Jan 19, 2024

Conversation

filipwastberg
Copy link
Contributor

I found the work around for how to use the source_dir option correctly in this old issue: #130.

I didn't understand how to use it through the docs so this PR adds an example to the docs.

Not sure if it is in the right place, so feel free to move it. I found quartodoc really helpful and easy to use (once I managed to find the above issue) to document a Python project that didn't end up as a package.

@machow
Copy link
Owner

machow commented Jan 18, 2024

Thanks for this PR -- I'm working on some quartodoc issues / features, and will take a look today!

@machow
Copy link
Owner

machow commented Jan 19, 2024

LGTM, thanks for taking the time to write this up!

@machow machow merged commit c0c57a7 into machow:main Jan 19, 2024
5 of 6 checks passed
@ecomodeller
Copy link

@filipwastberg Nice. I can imagine this type of project structure applies to a wide range of both commercial and academic projects, where the goal is not to create a reusable library, but still being able to make sense of the code. 👍

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.

3 participants