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

Migrate docs to ReadTheDocs #51

Open
ryanjjung opened this issue Nov 13, 2024 · 1 comment
Open

Migrate docs to ReadTheDocs #51

ryanjjung opened this issue Nov 13, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request low_priority

Comments

@ryanjjung
Copy link
Collaborator

ryanjjung commented Nov 13, 2024

Thunderbird has a ReadTheDocs subscription, and we have precedent with other projects publishing docs there. tb_pulumi currently has a custom-ish Sphinx build and a Github Action workflow to publish them to Github Pages. This is extremely low priority, but we might consider publishing to ReadTheDocs at some point in the future.

@ryanjjung ryanjjung added enhancement New feature or request documentation Improvements or additions to documentation low_priority labels Nov 13, 2024
@ryanjjung ryanjjung changed the title Migrate docs to Readthedocs Migrate docs to ReadTheDocs Nov 18, 2024
@MelissaAutumn
Copy link
Member

Here's a sample .readthedocs.yaml file:
https://github.com/thunderbird/thunderbird-accounts/blob/main/.readthedocs.yaml

And my sphinx conf.py for any extras:
https://github.com/thunderbird/thunderbird-accounts/blob/main/docs/conf.py

in my case I use uv for the project, so I need to generate a lockfile, but you should be able to remove that section if we're just using pip here.

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 enhancement New feature or request low_priority
Projects
None yet
Development

No branches or pull requests

2 participants