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

update docs to python 3 #389

Merged
merged 2 commits into from
Aug 2, 2021
Merged

Conversation

bobmyhill
Copy link
Member

The old sphinx conf.py file does not work with python 3.
This PR

  • updates that file,
  • updates the master index file, and also
  • removes some whitespace and duplicate keywords variables from ref.bib.

@bobmyhill bobmyhill mentioned this pull request Aug 1, 2021
6 tasks
@bobmyhill bobmyhill added this to the 0.10.0 milestone Aug 1, 2021
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'),
Copy link
Member

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?

@bobmyhill
Copy link
Member Author

This still isn't working; a lot of the docs are missing. I'll see if I can fix it tomorrow.

@bobmyhill
Copy link
Member Author

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):

  :members:
  :undoc-members:
  :show-inheritance:
  :inherited-members:

@tjhei
Copy link
Member

tjhei commented Aug 2, 2021

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?

@bobmyhill
Copy link
Member Author

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.

Copy link
Member

@tjhei tjhei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@tjhei tjhei merged commit 74da10e into geodynamics:master Aug 2, 2021
@bobmyhill bobmyhill deleted the update_doc_0_10_0 branch November 3, 2021 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants