Linking of documentation version with setup.cfg

OpenMined / PyDP

The Python Differential Privacy Library. Built on top of: https://github.com/google/differential-privacy

Apache License 2.0

497 stars 136 forks source link

Linking of documentation version with setup.cfg #234

Closed chinmayshah99 closed 4 years ago

chinmayshah99 commented 4 years ago

Description

Using bumpversion, we are able to change the version of python version throughout the codebase. It would be great if we could add version number in the documentation to setup.cfg

Additional info

Check on how bumpvesion works.

jandremarais commented 4 years ago

Hi, I haven't used bumpversion before but would like to help. Do I understand correctly that you want to add a file specific configuration for docs/conf.py to setup.cfg like this:

[bumpversion:file:docs/conf.py]
search = version="{current_version}"
replace = version="{new_version}"

jandremarais commented 4 years ago

As suggested by @BenjaminDev, the other option is just to replace version=u"0.1.1 with version=pydp.__version__ and similarly for release (in docs/conf.py). The docs build as expected with it configured this way. Which solution do you think is best?