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

Improve Sphinx's usability with GitHub Pages #10472

Open
AA-Turner opened this issue May 23, 2022 · 1 comment
Open

Improve Sphinx's usability with GitHub Pages #10472

AA-Turner opened this issue May 23, 2022 · 1 comment
Labels
type:enhancement enhance or introduce a new feature

Comments

@AA-Turner
Copy link
Member

This is a summary of the actionable content from #3382

Action 1: We should add a target that renders documentation and then commits it to the gh-pages branch, if currently within a git repository. This would be similar to MkDocs' gh-deploy option. (see #3382 (comment))

Action 2: We should also add a brief guide (perhaps in sphinx.ext.githubpages) on how best to configure sphinx-build et al for deploying to GHP, if one wants to commit rendered documentation to the master branch. (Similar to #3382 (comment))

A

@pradyunsg
Copy link
Contributor

Is there any reason to not be generating the nojekyll file by default?

@AA-Turner AA-Turner added this to the some future version milestone Sep 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

2 participants