Collect common links under custom file #82

jorgepiloto · 2022-04-19T16:58:14Z

Resolves #70.

doc/source/coding_style/flake8.rst

doc/source/abstractions/data-transfer.rst

jorgepiloto · 2022-04-20T08:47:54Z

doc/source/links.rst

+.. _PyAEDT: https://github.com/pyansys/pyaedt
+.. _PyMAPDL: https://github.com/pyansys/pymapdl
+.. _PyAnsys: https://docs.pyansys.com/
+.. _PyAnsys PyPI: https://pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi


This link does no longer work.

doc/source/abstractions/data-transfer.rst

Co-authored-by: Maxime Rey <[email protected]>

jorgepiloto · 2022-05-03T15:56:01Z

The error in the PDF building process is caused by this PR, as the nightly build ran without problems. Reading the logs locally to identify the problem...

jorgepiloto · 2022-05-04T06:24:21Z

This is likely to be introduced by some "infinite-loop" when solving links. This works fine in the HTML builder but not sure if will do so for the PDF.

jorgepiloto · 2022-05-04T16:46:32Z

This guide might be an alternate approach to this: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#setup-external-links

PipKat · 2022-05-05T19:29:21Z

doc/source/abstractions/app-interface.rst

+placing them into the ``vars`` list, all while following the Style
+Guide for Python Code, defined in `PEP 8`_.


Suggested change

placing them into the ``vars`` list, all while following the Style

Guide for Python Code, defined in `PEP 8`_.

placing them into the ``vars`` list, all while following the style

guidelines for Python code that are defined in `PEP 8`_.

PipKat · 2022-05-05T19:29:57Z

doc/source/abstractions/data-transfer.rst

@@ -3,10 +3,10 @@ Data Transfer

 Abstracted APIs should attempt to hide the implementation details of
 the remote or local API in a well organized data model.  This data
-model should avoid returning raw JSON files, gRPC messages, SWIG objects,
+model should avoid returning raw JSON files, gRPC messages, `SWIG`_ objects,
 or .NET objects. It should preferably return standard Python objects


Suggested change

or .NET objects. It should preferably return standard Python objects

and .NET objects. It should preferably return standard Python objects

PipKat · 2022-05-05T19:31:12Z

doc/source/abstractions/service.rst

+Consider the following code examples. The left-hand side shows the amount of
+work to start, establish a connection to, and submit an input file to MAPDL
+using auto-generated gRPC interface files. For more information, see
+`pyansys-protos-generator`_. The right-hand side shows the same workflow but
+uses the `PyMAPDL`_ library.


Suggested change

Consider the following code examples. The left-hand side shows the amount of

work to start, establish a connection to, and submit an input file to MAPDL

using auto-generated gRPC interface files. For more information, see

`pyansys-protos-generator`_. The right-hand side shows the same workflow but

uses the `PyMAPDL`_ library.

Consider the following code examples. The left side shows the amount of

work to start, establish a connection to, and submit an input file to MAPDL

using auto-generated gRPC interface files. For more information, see

`pyansys-protos-generator`_. The right side shows the same workflow but

uses the `PyMAPDL`_ library.

PipKat · 2022-05-05T19:32:05Z

doc/source/coding_style/beyond_pep8.rst

@@ -1,15 +1,15 @@
 Beyond PEP8
-###########
+===========
 This topic describes any delineations, clarifications, or additional procedures above and 


Suggested change

This topic describes any delineations, clarifications, or additional procedures above and

This topic describes any delineations, clarifications, or additional procedures

PipKat · 2022-05-05T19:32:42Z

doc/source/coding_style/beyond_pep8.rst

-outlines deprecation best practices and a `Deprecation library <https://deprecation.readthedocs.io/>`_ 
-already exists. However, there is no official guidance regarding deprecating features 
-in an API within Python. This page seeks to clarify this issue and others.
+For example, `Stack Overflow Answer`_ outlines deprecation best practices and a


Suggested change

For example, `Stack Overflow Answer`_ outlines deprecation best practices and a

For example, `Stack Overflow Answer`_ outlines deprecation best practices, and a

PipKat · 2022-05-05T19:36:56Z

doc/source/documentation_style/deployment.rst

+open-source nature of the project, documentation built by each PyAnsys library
+or project should be public and editable by users and the community at large.
+
+After following the documentation build strategy contained within both the


Suggested change

After following the documentation build strategy contained within both the

After following the documentation build strategy contained within both

germa89 · 2022-09-12T15:09:48Z

doc/source/links.rst

+.. _pandas: https://pandas.pydata.org/
+.. _pyvista: https://docs.pyvista.org/
+.. _scipy: https://scipy.org/
+.. _tensorflow: 


Why this is empty?? @jorgepiloto

PipKat · 2024-03-13T21:35:39Z

@jorgepiloto and @RobPasMue In draft PR #410, I moved all links with explicit target names to a central link file, I believe that we could close this PR.)

RobPasMue · 2024-03-14T07:31:36Z

Let's close it yeah - thanks @PipKat - I'll review that one =)

MaxJPRey reviewed Apr 19, 2022

View reviewed changes

doc/source/coding_style/flake8.rst Outdated Show resolved Hide resolved

MaxJPRey approved these changes Apr 19, 2022

View reviewed changes

MaxJPRey self-requested a review April 19, 2022 18:48

jorgepiloto force-pushed the feat/links branch 5 times, most recently from f642329 to 58e7b72 Compare April 20, 2022 11:32

PipKat reviewed Apr 20, 2022

View reviewed changes

doc/source/abstractions/data-transfer.rst Show resolved Hide resolved

jorgepiloto force-pushed the feat/links branch from 58e7b72 to 260f14b Compare April 20, 2022 14:29

jorgepiloto commented Apr 20, 2022

View reviewed changes

jorgepiloto force-pushed the feat/links branch 3 times, most recently from 8f9bab5 to a6b67c5 Compare April 20, 2022 18:09

jorgepiloto and others added 3 commits May 3, 2022 13:56

New doc/source/links.rst file

78b1358

Clean links in doc files

b9ec75b

Apply suggestions from code review

9732ea1

Co-authored-by: Maxime Rey <[email protected]>

jorgepiloto force-pushed the feat/links branch 2 times, most recently from 4cc82cb to fdefe74 Compare May 3, 2022 12:45

MaxJPRey requested a review from Revathyvenugopal162 May 3, 2022 13:23

jorgepiloto force-pushed the feat/links branch 3 times, most recently from cd1fa2b to d99348e Compare May 3, 2022 15:47

Fix links and cross-references

d004381

jorgepiloto force-pushed the feat/links branch from d99348e to d004381 Compare May 4, 2022 06:19

PipKat reviewed May 5, 2022

View reviewed changes

germa89 reviewed Sep 12, 2022

View reviewed changes

RobPasMue mentioned this pull request Oct 25, 2022

Adding links.rst to docs ansys/pymapdl#1506

Merged

RobPasMue closed this Mar 14, 2024

RobPasMue deleted the feat/links branch March 14, 2024 07:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Collect common links under custom file #82

Collect common links under custom file #82

jorgepiloto commented Apr 19, 2022

jorgepiloto Apr 20, 2022

jorgepiloto commented May 3, 2022

jorgepiloto commented May 4, 2022

jorgepiloto commented May 4, 2022

PipKat May 5, 2022

PipKat May 5, 2022

PipKat May 5, 2022

PipKat May 5, 2022

PipKat May 5, 2022

PipKat May 5, 2022

germa89 Sep 12, 2022

PipKat commented Mar 13, 2024

RobPasMue commented Mar 14, 2024

		placing them into the ``vars`` list, all while following the Style
		Guide for Python Code, defined in `PEP 8`_.

	or .NET objects. It should preferably return standard Python objects
	and .NET objects. It should preferably return standard Python objects

	This topic describes any delineations, clarifications, or additional procedures above and
	This topic describes any delineations, clarifications, or additional procedures

	For example, `Stack Overflow Answer`_ outlines deprecation best practices and a
	For example, `Stack Overflow Answer`_ outlines deprecation best practices, and a

	After following the documentation build strategy contained within both the
	After following the documentation build strategy contained within both

Collect common links under custom file #82

Collect common links under custom file #82

Conversation

jorgepiloto commented Apr 19, 2022

Choose a reason for hiding this comment

jorgepiloto commented May 3, 2022

jorgepiloto commented May 4, 2022

jorgepiloto commented May 4, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PipKat commented Mar 13, 2024

RobPasMue commented Mar 14, 2024