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.

Sign up for GitHub

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

Jump to bottom

Versioning our documentation #313

Closed
junpenglao opened this issue Sep 21, 2022 · 2 comments
Closed

Versioning our documentation #313

junpenglao opened this issue Sep 21, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@junpenglao
Copy link
Member

Currently the doc is only showing HEAD, we should at least add latest release tag to the doc.
@junpenglao junpenglao added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Sep 21, 2022
@rlouf rlouf mentioned this issue Sep 24, 2022
Merged
@rlouf
Copy link
Member

rlouf commented Sep 24, 2022 •
edited
Loading

We should investigation actions like this one. One simple strategy is to build the doc in a new folder tag_name at each release, and overwrite the doc in the folder head on every push to main. The previous action also allows to bubble up Sphinx Build errors in the PR, which already goes a long way (since it tests running examples).

In the meantime, I changed the workflow in #346 to only publish the docs on release, imo a safer default than on every push on HEAD. Especially now that we're going to refactor the library a little before v1.

@junpenglao
Copy link
Member Author

duplicate with #434

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rlouf @junpenglao