Giter VIP home page Giter VIP logo

Comments (5)

reinout avatar reinout commented on July 22, 2024

I tried it once with the pkg_resources version number grabber like you also suggested in #37 (comment). I didn't get separate versions in readthedocs' userinterface, though, so I might have missed a readthedocs settings checkbox somewhere. Or I mixed up sphinx' use of 'version' and 'release'.

In the end, the solution for this issue should be the same one as for the version string problem in #37. Do you agree?

Hm. We should really put zest.releaser's version in version and in the sphinx docs! :-)

from zest.releaser.

reinout avatar reinout commented on July 22, 2024

I just looked at the docs again: version/release are often the same in sphinx. Unless you want to differentiate between a version "1.2" and a more fine-grained release "1.2.3".

Note: In edb45c3 I'm setting version/release via pkg_resources in our very own docs.

Warning to developers on zest.releaser itself: you need to re-run buildout before bin/sphinx works again :-)

from zest.releaser.

reinout avatar reinout commented on July 22, 2024

Ok, adding that version gave me an error on readthedocs:

Exception occurred:
  File "/home/docs/local/lib/python2.7/site-packages/pkg_resources.py", line 565, in resolve
    raise DistributionNotFound(req)  # XXX put more info here
DistributionNotFound: zest.releaser

Which means I have to enable the "use virtualenv" checkbox in the sphinx settings.
Note that inconveniences like this could be a reason to "just" update the version string in a second place.

What about some defaults? Look by default in a doc[s]/source/conf.py file and in a your_package/init.py file for version/release/version items we can set in addition to the one in VERSION.txt or setup.py? Additional files can be set in a config setting.

from zest.releaser.

miohtama avatar miohtama commented on July 22, 2024

Hi Reinous,

I think

edb45c3

... was exactly the thing I was looking for!

from zest.releaser.

reinout avatar reinout commented on July 22, 2024

In the versions issue, another option was named:

version = __import__("zest.releaser").__version__

Similar. I prefer the pkg_resources one :-)

from zest.releaser.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.