search

cthoyt / cookiecutter-snekpack

🍪 A cookiecutter package for an enlightened python package
MIT License
35 stars 7 forks source link

Doc testing locally #14

Closed YojanaGadiya closed 1 year ago

YojanaGadiya commented 1 year ago

@cthoyt any pointers on how to test the docs locally and see how it would look in the ReadtheDocs?

Thanks.

cthoyt commented 1 year ago

https://github.com/cthoyt/cookiecutter-snekpack/tree/main/%7B%7Bcookiecutter.package_name%7D%7D#-building-the-documentation

cthoyt commented 1 year ago

you can also configure readthedocs to build from branches / PRs if you want to test. I think there's a way to get readthedocs as part of CI as well. If you figure that out and want to contribute a guide to this template, would be appreciated

YojanaGadiya commented 1 year ago

Sure. Let me take a look at get back to you.

cthoyt commented 1 year ago

See https://docs.readthedocs.io/en/stable/pull-requests.html