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

sphinx-multiversion to replace sphinxcontrib-versioning? #209

Merged
merged 4 commits into from
Apr 15, 2020

Conversation

rjleveque
Copy link
Member

We've been using sphinxcontrib-versioning to make doc pages with links to other versions, but I can't get this to work any more after updating various other Python packages. I ran into various issues, only some of which I could fix based on
sphinx-contrib/sphinxcontrib-versioning#70
and that issue makes me think this package may not be well supported going forward.

So I've tried switching to this new package:
https://holzhaus.github.io/sphinx-multiversion/master/index.html
which seems to work well and has some other advantages over the old way, I think. In particular:

  • It's easy to specify which branches/tags should be included in the versions listed and to customize the sidebar,
  • You can build all the versions within your local repo with what's in your branches, rather than having to push everything to GitHub in order for it to be included in the docs.

I posted a new version of the docs at
http://depts.washington.edu/clawpack/sampledocs/sphinx-multiversion/contents.html

Feedback welcome!

@mandli
Copy link
Member

mandli commented Apr 6, 2020

There are some links that are broken and I am wondering if this is a relative path problem? For example the page for geoclaw has some warnings (as does other pages).

@mandli
Copy link
Member

mandli commented Apr 6, 2020

Looks great otherwise!

@rjleveque
Copy link
Member Author

Yes, I forgot to mention that nbsphinx is also not working for me now, so pages generated automatically from notebooks are failing. Still working on that...

@rjleveque
Copy link
Member Author

I will go ahead with this unless there are any objections.

I'd also like to make some other changes, listed in #210.

@mandli mandli merged commit 85f3f9a into clawpack:dev Apr 15, 2020
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 this pull request may close these issues.

2 participants