-
Notifications
You must be signed in to change notification settings - Fork 41
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
update docs to python 3 #389
Conversation
db21c2d
to
d669f8c
Compare
sphinx/conf.py
Outdated
} | ||
|
||
# Grouping the document tree into LaTeX files. List of tuples | ||
# (source start file, target name, title, author, documentclass [howto/manual]). | ||
latex_documents = [ | ||
('index_pdf', 'BurnMan.tex', u'BurnMan Documentation', | ||
u'Sanne Cottaar, Timo Heister, Robert Myhill, Ian Rose, Cayman Unterborn', 'manual'), | ||
u'Sanne Cottaar, Timo Heister, Robert Myhill, Ian Rose, Cayman Unterborn', 'manual'), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you use the authors variable instead?
This still isn't working; a lot of the docs are missing. I'll see if I can fix it tomorrow. |
be2c225
to
81e2eaf
Compare
Ok, the autogenerated part of the manual is complete again. I needed to explicitly set the autodoc settings with some or all of the below (depending on case):
|
I am not sure, but can you achieve the same by setting https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html instead of adding it to every class? |
81e2eaf
to
24ac020
Compare
Ah, thanks @tjhei. The autodoc defaults weren't being obeyed because the object name changed, and is now required to be a dict rather than a list. The functionality has still changed a bit (it is now more logical), but I've been able to remove most of the new lines. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
The old sphinx conf.py file does not work with python 3.
This PR