Skip to content

Commit ee826ff

Browse files
Fix broken links documentation practices (#61)
* Fix broken links doc practices * Update doc/source/guidelines/doc_practices.rst Co-authored-by: Alex Kaszynski <[email protected]>
1 parent 99a839d commit ee826ff

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

doc/source/guidelines/doc_practices.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,10 +148,9 @@ For instance: `grantami <https://grantami.docs.pyansys.com>`_
148148
Regarding the documentation dedicated to a specific feature of the product or an example, the URL is formatted like this:
149149
``<extra>.<product_name>.docs.pyansys.com``
150150

151-
For instance: `cartpole <https://cartpole.mapdl.docs.pyansys.com>`_
151+
For instance: `cartpole <https://pyansys.github.io/ml-rl-cartpole/>`_
152152

153-
Once the URL name has been decided, it must be specified in the "Settings" of the repository under the "Custom domain" section.
154-
For example, `see <https://github.com/pyansys/grantami-bomanalytics-docs/settings/pages>`_
153+
Once the URL name has been decided, it must be specified in the "Settings -> Pages -> Custom domain" section of the repository.
155154

156155
Then, the URL has to be registered using Microsoft Azure to set the DNS properly and link it to the ANSYS organization.
157156
This action will be performed by one of the Ansys administrator of Microsoft Azure account.

0 commit comments

Comments
 (0)