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

unable to preview changes #22

Closed
pdurbin opened this issue May 26, 2021 · 0 comments · Fixed by #23
Closed

unable to preview changes #22

pdurbin opened this issue May 26, 2021 · 0 comments · Fixed by #23

Comments

@pdurbin
Copy link
Contributor

pdurbin commented May 26, 2021

When I introduced the sphinx-multiversion extension in e2f5e5f as part of #15, it had the unintended consequence of preventing us from previewing edits that haven't been committed yet.

That is to say, the extension works by checking out each branch or tag so you only see what's been committed, not what you just edited.

pdurbin added a commit that referenced this issue May 26, 2021
We want `make html` to work fine for devs who are editing the docs and
want to preview changes. Devs or doc writers or whatever.

When we build the docs to deploy to production, we want all the versions
of the docs to be built. These are only built from tags or the commits
in branches. That's how the sphinx-multiversion extension works. To call
this purpose `make versions` has been added.
raprasad added a commit that referenced this issue May 27, 2021
`make html` for devs, `make versions` to deploy #22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant