Comments (3)
@sehnem Thanks for your answer.
If I understood sphinxcontrib-versioning
's behavior correctly, then it would not install the package version for which it is generating the documentation? In example: when it switches from 2.0.0 to 1.0.0 to generate the old docs, it would not actually install version 1.0.0 of the package before doing so?
If so, then I think it is a risky approach and could be worse than just having a non-expected value in the |version|
number.
For example, a project that executes Python code that uses the package within the documentation. Imagine Matplotlib's documentation, where the output figures are auto-generated from the docs: if the correct version of Matplotlib is not installed before generating the docs then the output could be different, wrong or generation could even fail.
@sehnem What do you think? Could I be missing something or misunderstanding the current behavior? To be honest, I have not dig into sphinxcontrib-versioning
's source code.
from sphinxcontrib-versioning.
Hi,
I'm having the same problem, but I think i know of what causes it.
In the steps to reproduce the problem you install the package, then you generate the documentation. Look how you pick the version for the documentation in your conf.py:
import osbrain
release = osbrain.__version__
This way you will always pick the version of the installed version.
In the conf.py from this package the version is picked from the setup file.
release = version = __import__('setup').VERSION
I think that changing it will solve the problem for you.
In my case I am using automatic versioning, so the versions are generated after the creation of the tag and I'm not able to take this approach. If someone knows what could I do, the package is https://gitlab.com/sehnem/pynmet.
from sphinxcontrib-versioning.
I have not worked a lot with this package, but I think that you cannot generate the documentation for each versions os the package since it builds all the documentation at once. If it is possible @Raythor approach should work, and it also would fix my problem.
I think that if it is not possible yet, implementing it would be useful for many applications. But maybe someone knows a way to make it work with different versions.
from sphinxcontrib-versioning.
Related Issues (20)
- Support themes inherited from sphinx_rtd_theme
- html_last_updated_fmt in conf.py causes build failure HOT 1
- How Sphinx Versioning Handle Package Changes Different Branches HOT 1
- Sphinx-versioning and Setuptools integration
- rtd theme navigation collides with rst-versions HOT 1
- Fail to build with Sphinx > 1.6.0 HOT 1
- ConfigInject class incompatible with Sphinx 1.8
- Error when running build HOT 6
- Project orphaned? HOT 57
- Set the Tempdir location HOT 1
- Documentation improvements
- ImportError: cannot import name 'build_main' HOT 10
- Build fails for release and forks, advice? HOT 27
- "IndexError: list index out of range" crash in case of big merge commits are in the git tree
- Make follow pylint standard closer.
- Disable sidebar html entries
- Build fails when using Sphinx tags HOT 1
- Incompatible with Sphinx >= 2.0 HOT 6
- Does not work with autosummary HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinxcontrib-versioning.