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 directory to cookiecutter template with the necessary tooling to build #30

Closed
lila opened this issue Dec 19, 2022 · 2 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lila
Copy link
Contributor

lila commented Dec 19, 2022

it would be nice to have the cookiecutter template that is created to include a docs directory that has the docs-as-code templates. for example https://github.com/lila/readthedoc-test uses sphinx and github actions to build and deploy in github pages. other frameworks are fine too...

@jonchenn jonchenn self-assigned this Jan 3, 2023
@jonchenn jonchenn added documentation Improvements or additions to documentation enhancement New feature or request and removed enhancement New feature or request labels Jan 3, 2023
@jonchenn
Copy link
Collaborator

jonchenn commented Jan 3, 2023

Thanks for the good suggestion, Karan. We use FastAPI that automatically generates swagger API docs, and we also use Redoc (https://github.com/Redocly/redoc) for the doc UI. I'll add these to this template documentation.

@lavjain
Copy link
Collaborator

lavjain commented Sep 22, 2023

Cookiecutter has been replaced by copier

@lavjain lavjain closed this as completed Sep 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants