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 multiple versions of the documentation. #33

Open
3 tasks
curtisma opened this issue Aug 21, 2022 · 0 comments
Open
3 tasks

Host multiple versions of the documentation. #33

curtisma opened this issue Aug 21, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@curtisma
Copy link
Contributor

Problem Statement

We are currently only hosting the documentation for the most recent version of virtue. However if a user is still using a previous version of virtue in their project they may want to consult the docs for that version.

Proposed Solution

We will move our documentation to be hosted on ReadTheDocs (RTD) rather than GitHub. RTD should be able to build and host the docs for free. We can even use it with our custom domain name.

Then different versions of the docs can be selected easily using a drop-down provided by the pydata theme:
image

Alternatives Considered

Proposed Action Plan

We should start by following the tutorial:
https://docs.readthedocs.io/en/stable/tutorial/

I'm sure the conf.py will need to be updated.

  • 1. we'll do this
  • 2. We'll do that
  • 3. Then we'll add tests for this and that.
@curtisma curtisma added the enhancement New feature or request label Aug 21, 2022
@curtisma curtisma self-assigned this Aug 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant