You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -122,6 +122,29 @@ extension, you must follow its `coding guidelines <https://sphinx-gallery.github
122
122
123
123
PyMAPDL provides a self-demonstrating example of how to `add an example reference key <https://mapdldocs.pyansys.com/examples/03-tips-n-tricks/00-example-template.html#ref-how-to-add-an-example-reference-key>`_.
124
124
125
+
126
+
URL of the documentation page
127
+
-----------------------------
128
+
To host the documentation related to a PyAnsys project, an easy way to go is to use GitHub Page.
129
+
This GitHub feature do not require any database to be setup nor to configure any server.
130
+
GitHub will serve the documentation related to the project from a URL tied to PyAnsys organization.
131
+
132
+
The standard name for this URL can be such as:
133
+
``<product_name>.docs.pyansys.com``
134
+
135
+
For instance: `grantami <https://grantami.docs.pyansys.com>`_
136
+
137
+
Regarding the documentation dedicated to a specific feature of the product or an example, the URL is formatted like this:
138
+
``<extra>.<product_name>.docs.pyansys.com``
139
+
140
+
For instance: `cartpole <https://cartpole.mapdl.docs.pyansys.com>`_
141
+
142
+
Once the URL name has been decided, it must be specified in the "Settings" of the repository under the "Custom domain" section.
143
+
For example, `see <https://github.com/pyansys/grantami-bomanalytics-docs/settings/pages>`_
144
+
145
+
Then, the URL has to be registered using Microsoft Azure to set the DNS properly and link it to the ANSYS organization.
146
+
This action will be performed by one of the Ansys administrator of Microsoft Azure account.
147
+
125
148
Accessing a Library's Documentation
126
149
-----------------------------------
127
150
Documentation for the latest stable release of a PyAnsys library is accessible
@@ -166,7 +189,7 @@ To use Windows PowerShell to clone a GitHub repository:
166
189
167
190
Because the list of repositories is quite long, you can use the ``Find
168
191
a repository`` option to search for the repository that you want to clone. For
169
-
example, you can seach for "theme" to find the ``pyansys-sphinx-theme`` repository.
192
+
example, you can search for "theme" to find the ``pyansys-sphinx-theme`` repository.
170
193
171
194
#. In the upper right corner of the repository, click the green ``Code`` button to
172
195
drop down a list of options.
@@ -206,7 +229,7 @@ Pushing Changes to the GitHub Repository
206
229
----------------------------------------
207
230
As you make changes in your ``doc/`` branch, you want to periodically test then in
208
231
local documentation builds as described in :ref:`doc_building`. After you resolve
209
-
any issues and are satisfied with what apears in a local build, you are ready
232
+
any issues and are satisfied with what appears in a local build, you are ready
210
233
to push your changes to the library's GitHub repository. To accomplish this,
211
234
you can use either Git commands or Git Extensions.
212
235
@@ -290,7 +313,7 @@ To use Git Extensions to push your changes to the GitHub repository:
290
313
are no conflicts with what is in your branch. If there are conflicts, resolve
291
314
them.
292
315
293
-
#. Do a push of your branch to the GitHub repsitory.
316
+
#. Do a push of your branch to the GitHub repository.
294
317
295
318
#. Create the PR as described in :ref:`create_pr`.
296
319
@@ -302,7 +325,7 @@ Creating the GitHub PR
302
325
Regardless of what method you used to push your changes, do the following to create
303
326
the GitHub PR:
304
327
305
-
#. Go to the GitHub reposity, where you will see an entry for your pushed branch.
328
+
#. Go to the GitHub repository, where you will see an entry for your pushed branch.
306
329
307
330
#. If the pushed branch resolves an issue, in its description, type ``Resolves #``
308
331
and select from the list of issues that appears.
@@ -313,7 +336,7 @@ the GitHub PR:
313
336
314
337
If your PR is ready for review, select ``Create pull request``. Otherwise,
315
338
select ``Create draft pull request`` and mark it as ready for review once
316
-
you it includes all of your changes and you are satisified with it.
339
+
you it includes all of your changes and you are satisfied with it.
317
340
318
341
If you need to change a PR title, to its right, click the ``Edit`` button,
319
342
which becomes a ``Save`` button while you are in editing mode.
0 commit comments