[WIP] change the relative location of the filename for source code lookup. Fixes #2126 #2127
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
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:
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:
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.
Run pydocstyle on your code.