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

Improve REL_SOURCE description #33

Open
edublancas opened this issue Dec 30, 2016 · 0 comments
Open

Improve REL_SOURCE description #33

edublancas opened this issue Dec 30, 2016 · 0 comments

Comments

@edublancas
Copy link

Hi, thanks for doing this, it's really useful!

Just a suggestion:

I was trying to generate the docs using:

sphinx-versioning build docs docs/build/html

But I was getting...

=> No docs found in any remote branch/tag. Nothing to do.

I couldn't fix it until I read the source code and realized that REL_SOURCE looks for the sphinx conf.py file to determine if the tag/branch has docs or not, but the description for REL_SOURCE in the build command says this:

 REL_SOURCE is the path to the docs directory relative to the git root. If
  the source directory has moved around between git tags you can specify
  additional directories.

I would be better to explain that the docs are found by using the conf.py cause it may be in other places, for example I have mine in docs/source/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant