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

Host Documentation on ReadTheDocs #96

Closed
6 tasks done
Teque5 opened this issue Jan 8, 2025 · 1 comment
Closed
6 tasks done

Host Documentation on ReadTheDocs #96

Teque5 opened this issue Jan 8, 2025 · 1 comment

Comments

@Teque5
Copy link
Collaborator

Teque5 commented Jan 8, 2025

I believe the guide to this is located here. Working on this in the feature/readthedocs branch.

  • Resolve organization permissions to readthedocs.org
  • add new config file to repo
  • post link in readme to docs & update pypi docs link
  • As python3.13 is the build env for the docs, let's update github actions to use that target also: python-version: ["3.7", "3.9", "3.11", "3.13"]
  • Move readme examples into docs
  • Point readthedocs to the main branch
@Teque5
Copy link
Collaborator Author

Teque5 commented Jan 15, 2025

This came together nicely.

@Teque5 Teque5 closed this as completed Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant