selenium icon indicating copy to clipboard operation
selenium copied to clipboard

[🚀 Feature]: Maintain different versions of documentation

Open PhilippSelenium opened this issue 4 years ago • 6 comments

Feature and motivation

Currently the documentation is only available for the 4.0.0 release. If there are interface changes and the documentation is updated I cannot use the official doc with sphinx anymore.

This is via many projects maintain a versioning scheme. 4.0.0, 4.1.0, latest, stable ...

Usage example

Use version of doc according to the version you installed via pip

PhilippSelenium avatar Oct 21 '21 05:10 PhilippSelenium

@PhilippSelenium, thank you for creating this issue. We will troubleshoot it as soon as we can.


Info for maintainers

Triage this issue by using labels.

If information is missing, add a helpful comment and then I-issue-template label.

If the issue is a question, add the I-question label.

If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

After troubleshooting the issue, please add the R-awaiting answer label.

Thank you!

github-actions[bot] avatar Oct 21 '21 05:10 github-actions[bot]

I spent multiple hours with Sphinx this past week without a lot to show for it. I attempted to use https://holzhaus.github.io/sphinx-multiversion/master/index.html working, but couldn't get it to do anything.

Alternatively we could generate our output to readthedocs and let them version it for us, and just keep the latest on our site.

titusfortner avatar Dec 26 '21 07:12 titusfortner

@symonk @AutomatedTester do you have any thoughts on this?

diemol avatar Aug 12 '22 05:08 diemol

Readthedocs would be great, it's also free and the setup is quite simple. As a plus, it also generates inventory files for all versions that is needed for proper intersphinx linking.

GergelyKalmar avatar Sep 04 '22 13:09 GergelyKalmar

I guess it depends what we want, I am a fan of either sphinx (and I also really like more recently Mkdocs with a material ui kind of thing) but I think we want documentation to be shared across languages? I only really contribute to the python bindings so I'm a little biased and like to use tooling that is python specific, I'm not really sure on what our overall goals with the docs are.

symonk avatar Sep 04 '22 15:09 symonk

fwiw, Java & Ruby both have versioned docs maintained on external sites as well (those are autogenerated by the respective sites, though, not something Selenium maintains). https://www.rubydoc.info/gems/selenium-webdriver/4.4.0/ https://www.javadoc.io/doc/org.seleniumhq.selenium/selenium-api/latest/org/openqa/selenium/package-summary.html

An acceptable answer is to have the latest version on our site, and previous versions on remote hosted elsewhere, if that's an option for Python.

titusfortner avatar Sep 04 '22 18:09 titusfortner

I've setup this https://selenium-python-api-docs.readthedocs.io/en/latest/index.html, which will maintain different versions of the docs from now on. I do not know how to generate docs for previous versions with the improved configuration. If anyone knows how to do that, please let me know!

diemol avatar Jun 08 '23 13:06 diemol

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

github-actions[bot] avatar Dec 09 '23 00:12 github-actions[bot]