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

Version selector on gh-pages like in pytorch docs #308

Closed
igormq opened this issue Nov 1, 2018 · 8 comments
Closed

Version selector on gh-pages like in pytorch docs #308

igormq opened this issue Nov 1, 2018 · 8 comments

Comments

@igormq
Copy link

igormq commented Nov 1, 2018

I think that many of us are installing the ignite using the master branch.

It would be nice if the ignite documentation also contains the master docs like https://pytorch.org/docs/versions.html.

What do you think?

Best,
Igor.

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Nov 1, 2018

@igormq today the documentation reflects the master version and not the stable 0.1.0.
I agree that it would be nice to add such selector between versions.

@miguelvr
Copy link
Contributor

miguelvr commented Nov 1, 2018

I think the easiest way is to host the documentation on readthedocs.org

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Nov 1, 2018

@miguelvr yes, it is pretty easy to deal with that in readthedocs.org, but today our docs are at pytorch.org/ignite and not all projects have this opportunity :)

@miguelvr
Copy link
Contributor

miguelvr commented Nov 1, 2018

yeah, but pytorch.org has the version selector, so I guess we can still do it.

Since you brought that up:

It is a shame that this project does not appear on https://pytorch.org/ecosystem, or is linked in the main page in some way.

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Nov 1, 2018

It is a shame that this project does not appear on https://pytorch.org/ecosystem, or is linked in the main page in some way.

@miguelvr yes, we talked about that with @soumith, he told that he will work on it, to highlight ignite and skorch, and we are still waiting :)

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Nov 28, 2018

Maybe we can use this plugin : https://github.com/Robpol86/sphinxcontrib-versioning
Probably installed from sphinx-contrib/sphinxcontrib-versioning#46

@anmolsjoshi
Copy link
Contributor

anmolsjoshi commented Mar 28, 2019

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Mar 28, 2019

@anmolsjoshi, your working prototype looks great and seems like doing what we need ...

@anmolsjoshi anmolsjoshi mentioned this issue Apr 4, 2019
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants