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

Setup "deeprob-kit-docs" repository or "gh-pages" branch for automatically versioned documentation #10

Closed
loreloc opened this issue Oct 13, 2021 · 0 comments · Fixed by #12 or #13
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@loreloc
Copy link
Member

loreloc commented Oct 13, 2021

Setup a new repository deeprob-org/deeprob-kit-docs or the special branch gh-pages containing versioned documentation.
Refer to sphinx-multiversion for building versioned documentation.
In particular, refer to a fork of sphinx-multiversion supporting sphinx-apidoc and sphinx-autodoc.

Finally, setup a GitHub Action to automatically push new documentation versions when:

  1. A push on main branch is made.
  2. A new tag/release is pushed.

However, this can also be done using Travis CI.

@loreloc loreloc added the documentation Improvements or additions to documentation label Oct 13, 2021
@loreloc loreloc changed the title Setup "deeprob-org/deeprob-kit-docs" repository for automatically versioned documentation Setup "deeprob-kit-docs" repository or "gh-pages" branch for automatically versioned documentation Oct 13, 2021
@loreloc loreloc self-assigned this Oct 13, 2021
gengala added a commit that referenced this issue Oct 14, 2021
@loreloc loreloc linked a pull request Oct 20, 2021 that will close this issue
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
Projects
None yet
1 participant