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

Development: find a good pattern for local doctools examples #203

Open
humitos opened this issue Nov 23, 2023 · 0 comments
Open

Development: find a good pattern for local doctools examples #203

humitos opened this issue Nov 23, 2023 · 0 comments
Labels
Improvement Minor improvement to code

Comments

@humitos
Copy link
Member

humitos commented Nov 23, 2023

Currently, we have pre-built examples for different doctools that you can access from the index page on the development server:

  • Sphinx
  • Pelican
  • Material for MkDocs

It would be good to expand this to a pattern with the following highlights:

  • Keep the sources next to the built output
  • Allows us to easily re-build the docs after changing a setting
  • Add more examples easily
  • Don't load the repository with a lot garbage data (e.g. Docusaurus generates a lot of files)

Questions:

  • How we can achieve this?
  • Is it a good idea to integrate this repository with test-builds somehow?
  • Can we build them on-the-fly when running npm run dev:examples? 1

Reference: #200 (comment)

Footnotes

  1. I think this will be awesome of possible! 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

1 participant