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

gh-pages-release branch needs to be existing prior to docs build? #28

Open
jgosmann opened this issue May 11, 2019 · 3 comments
Open

gh-pages-release branch needs to be existing prior to docs build? #28

jgosmann opened this issue May 11, 2019 · 3 comments

Comments

@jgosmann
Copy link

It seems that the gh-pages-release branch needs to be created prior to building the docs? Not entirely sure, though, because it seems like the docs were built anyways, but then the built was reported as failed after that.

@drasmuss
Copy link
Member

Yes that is correct (that the gh-pages-release branch needs to be manually created).

@jgosmann
Copy link
Author

Should it be empty or branch off of master?

@drasmuss
Copy link
Member

It should be empty, and then docs from future releases will be added to that branch. Or, if you wanted to initialize it with some past releases, you can manually generate those past release builds like

sphinx-build -b html docs <docs-dir>/<release-tag>

where <release-tag> is the tag for the release whose documentation you're building, e.g. v0.5.0, and <docs-dir> is what will become the base of gh-pages-release. So you should end up with a directory structure like

<docs-dir>
    /v0.4.0
    /v0.5.0
    /v0.6.0

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

No branches or pull requests

2 participants