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

Sphinx docs version #103

Closed
jared321 opened this issue Jul 19, 2024 · 6 comments
Closed

Sphinx docs version #103

jared321 opened this issue Jul 19, 2024 · 6 comments
Assignees

Comments

@jared321
Copy link
Contributor

The PDF version of the sphinx docs list the document as release 0.1.0, which I suspect is taken from the sphinx file conf.py. Do you want the version of the doc to have its own version number or be tied to the version of the Taweret python package? For the latter, you should be able to setup the package (if not already done so) so that after importing Taweret in conf.py you can get the package's version number from the package itself (e.g., release = Tawaret.__version__).

@asemposki
Copy link
Collaborator

I would be fine with it keeping the same number as the current Taweret version. I will fix this before the v0.4 release.

@asemposki
Copy link
Collaborator

I attempted the fix above, but it failed. Will figure out how to fix that, since I think we have the version set up in the __init__ of the package.

@jared321
Copy link
Contributor Author

Make sure that you import Taweret in conf.py as well.

@asemposki
Copy link
Collaborator

I think it's working now.

@asemposki
Copy link
Collaborator

OK now it is building with the simpler Taweret.__version__ call, so this Issue should be complete.

@asemposki
Copy link
Collaborator

Look good, closing.

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

2 participants