README.rst and conf.py update #1138
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sbillinge
reviewed
Jul 19, 2024
README.rst
Outdated
| Docs: | ||
| ----- | ||
| https://regro.github.io/regolith-docs/ | ||
| For more information on regolith please visit the project `web-page <https://regro.github.io/>`_ or email Prof. Simon Billinge at sb2896@columbia.edu. |
There was a problem hiding this comment.
I think this link needs to be fixed. It is going to the wrong place.
| from regolith import __version__ as REGOLITH_VERSION | ||
| from regolith.fsclient import _id_key, dump_json, json_to_yaml | ||
| from regolith.main import CONNECTED_COMMANDS, DISCONNECTED_COMMANDS | ||
| from regolith.schemas import EXEMPLARS, SCHEMAS | ||
|
|
||
| autodoc_mock_imports = [ |
There was a problem hiding this comment.
please can you double check that this is needed?
There was a problem hiding this comment.
Yes, otherwise it would run into issues like e.g. WARNING: autodoc: failed to import module '...' from module 'regolith'; the following exception was raised: No module named 'regolith'. Something like that. It is the solution that resolves this issue that gives in the api workflow.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Merge README.rst and conf.py (safe merge to api)