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

[WIP] change the relative location of the filename for source code lookup. Fixes #2126 #2127

Merged
merged 1 commit into from
Apr 30, 2021

Conversation

adam-kerrigan
Copy link
Contributor

@adam-kerrigan adam-kerrigan commented Apr 30, 2021

Summary

  • Generation of links to source code in the pymatgen.core have been fixed.
  • Generation of links to source code where the line numbers cannot be found have been fixed.

This fixes #2126. I was unsure on the difference between conf-docset.py, conf-normal.py and conf.py so I only updated the ones with the linkcode_resolve function in.

TODO (if any)

Generation of the Documentation, I couldn't find a guide to building the documentation and when I do I get far more changes than I expect as well as 608 warnings from sphinx some of which are listed below:

  • Adds '()' to end of property names in genindex.html
  • Adds a space to the end of the meta tags
  • Removes alt="Documentation Home" from every page.

Also I have noticed that the documentation for BoltzTraP2 is missing on the doc site however when I build it is present.

Before a pull request can be merged, the following items must be checked:

  • Code is in the standard Python style. The easiest way to handle this
    is to run the following in the correct sequence on your local machine. Start with running
    black on your new code. This will automatically reformat
    your code to PEP8 conventions and removes most issues. Then run
    pycodestyle, followed by
    flake8.
  • Docstrings have been added in the Google docstring format.
    Run pydocstyle on your code.
  • Type annotations are highly encouraged. Run mypy to type check your code.
  • Tests have been added for any new functionality or bug fixes.
  • All linting and tests pass.

@shyuep shyuep merged commit af9c2f5 into materialsproject:master Apr 30, 2021
@shyuep
Copy link
Member

shyuep commented Apr 30, 2021

Thanks.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.6%) to 83.013% when pulling e2158fc on adam-kerrigan:doc_conf into cb9854d on materialsproject:master.

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

Successfully merging this pull request may close these issues.

Source code link in documentation of surface module leads to 404
3 participants