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

Move docs into gh-pages branch #1

Closed
mottosso opened this issue Aug 22, 2019 · 2 comments · Fixed by #27
Closed

Move docs into gh-pages branch #1

mottosso opened this issue Aug 22, 2019 · 2 comments · Fixed by #27

Comments

@mottosso
Copy link
Owner

Command reference is currently generated with Sphinx locally, and pushed to the repository alongside code. This is problematic because..

  1. The user need all dependencies (Maya, Sphinx, nose, plug-ins) in order to update the docs
  2. Repository bloated with generated content, hard to know what to edit when making changes.

Instead, each push should trigger a re-build of the documentation and upload into the gh-pages branch of this repository.

@mottosso mottosso added enhancement New feature or request technical debt and removed enhancement New feature or request labels Aug 22, 2019
mottosso pushed a commit that referenced this issue Oct 7, 2020
@monkeez
Copy link
Collaborator

monkeez commented Oct 8, 2020

I've started looking into this one, I had one question. When would you want to trigger the docs to deploy? Pushes to master? Releases only?

@mottosso
Copy link
Owner Author

mottosso commented Oct 9, 2020

Oh that would be swell, thank you. Releases only, users are recommended to only use the latest release, rather than master, and that way they would stay up to date with whichever version users have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants