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 automodule #212

Merged
merged 20 commits into from
Jul 12, 2023
Merged

Feat automodule #212

merged 20 commits into from
Jul 12, 2023

Conversation

machow
Copy link
Owner

@machow machow commented Jul 6, 2023

This PR addresses #158, by autogenerating site content, when no sections: are specified.

For example, this config...

quartodoc:
  package: quartodoc

Will cause quartodoc build to produce a basic website, based on the top-level quartodoc module, with this message:

Autogenerating contents (since no contents specified in config)
Use the following configuration to recreate the automatically generated site:


package: quartodoc
sections:
- contents:
  - name: get_function
  - name: get_object
  - name: Builder
  - name: MdRenderer
  - name: convert_inventory
  - name: create_inventory
  - name: preview
  - name: blueprint
  - name: collect
  - name: Auto
  desc: quartodoc is a package for building delightful python API documentation.
  title: quartodoc

edit:

It also addresses #197, by implementing class documentation inside modules.

@juliasilge
Copy link
Collaborator

This is looking great! It might be good to note that this configuration goes into your _quarto.yml, like maybe something like:

Use the following configuration in your _quarto.yml to recreate the automatically generated site:

@machow
Copy link
Owner Author

machow commented Jul 7, 2023

Wow, added snapshots tests with syrupy, and it behaves a lot like testthat snapshots! For example, snapshots for a test file are all contained in a single .ambr file (which seems to be a custom format, and somewhat like testthat)

https://github.com/machow/quartodoc/blob/d4b9456caad0d87047c30e8aa2ba724fea134f69/quartodoc/tests/__snapshots__/test_renderers.ambr

Would be cool to contribute a serializer to markdown, so we can use some of the github markdown affordances

@machow machow marked this pull request as ready for review July 12, 2023 18:48
@machow machow merged commit 599737b into main Jul 12, 2023
4 checks passed
@machow machow deleted the feat-automodule branch October 12, 2023 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants