-
Notifications
You must be signed in to change notification settings - Fork 7
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
docs: reformat the documentation #396
Conversation
bb0d2b7
to
e0a9227
Compare
62d6050
to
3c3ae4a
Compare
…-theme into docs/reformat
doc/source/user-guide/linkcode.rst
Outdated
|
||
This page contains the shipped extensions that seamlessly integrate with this theme to enhance | ||
documentation functionality. | ||
|
||
Linkcode extension |
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.
Linkcode extension | |
The ``linkcode`` extension |
I can't find any doc that refers to this by anything but the extension/package name. Occurrences of "Linkcode" should be changed to linkcode
extension.
doc/source/user-guide/linkcode.rst
Outdated
To use the ``ansys-sphinx-theme`` linkcode extension, you need to add it to the Sphinx configuration: | ||
|
||
#. Add the following line in the ``conf.py`` file: |
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.
To use the ``ansys-sphinx-theme`` linkcode extension, you need to add it to the Sphinx configuration: | |
#. Add the following line in the ``conf.py`` file: | |
To use the ``linkcode`` extension, you must add it to the ``extensions`` variable in your | |
project's Sphinx ``conf.py`` file: |
You shouldn't have a procedure with only one step. You will need to fix the indentation of the code block.
@@ -197,8 +197,6 @@ def link_code(app: Sphinx, doctree: Node): | |||
The `link_code_library` configuration option can be used to specify a custom library | |||
for link resolution. | |||
|
|||
Notes | |||
----- | |||
Adapted from the original `linkcode` extension in Sphinx, see |
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.
Adapted from the original `linkcode` extension in Sphinx, see | |
Adapted from the original ``linkcode`` extension in Sphinx. For more information, see |
What is adapted? This sentence needs a sentence and it should have display text for the link (rather than the URL itself).
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.
changed this to
The ``linkcode`` extension in this version has been adapted from the original
`Sphinx linkcode extension <https://github.com/sphinx-doc/sphinx/blob/main/sphinx/ext/linkcode.py>`_.
This adaptation involves modifying the original code and functionality from the Sphinx library.
The `link_code_library` configuration option can be used to specify a custom library | ||
for link resolution. |
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.
The `link_code_library` configuration option can be used to specify a custom library | |
for link resolution. | |
You can use the ``link_code_library`` configuration option to specify a custom library | |
for link resolution. |
I'd like to make some edits to the preceding lines but I can't do so in this PR. There are additional places where single backticks are used instead of double backticks. Single backticks render as italics in the doc (rather than as a code entity).
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.
Lots of suggestions for you.
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]> Co-authored-by: Sébastien Morais <[email protected]>
…-theme into docs/reformat
Co-authored-by: Kathy Pippert <[email protected]>
Thank you for the detailed review, @PipKat. I have addressed all the comments, I hope you can open a documentation review at your convenience once this PR is merged as mentioned above. |
fix #373 #404
This pull request enhances the documentation for the Ansys Sphinx theme with the following updates: