add a file with refs and links to be used in the doc

Author: luisaFelixSalles

doc/source/links_and_refs.rst

@@ -0,0 +1,55 @@
+
+=====
+Links
+=====
+
+Pyansys
+^^^^^^^
+.. _pyansys: https://docs.pyansys.com/version/dev/
+
+PyAnsys Developer Guide
+^^^^^^^^^^^^^^^^^^^^^^^
+.. _dev_guide_pyansys: https://dev.docs.pyansys.com
+.. _dev_guide_contributing: https://dev.docs.pyansys.com/how-to/contributing.html
+.. _dev_guide_coding_style: https://dev.docs.pyansys.com/coding-style/index.html
+.. _dev_guide_setup_your_environment: https://dev.docs.pyansys.com/how-to/setting-up.html
+.. _dev_guide_branch_names: https://dev.docs.pyansys.com/how-to/contributing.html#branch-naming-conventions
+.. _dev_guide_commit_names: https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions
+
+Other libraries
+^^^^^^^^^^^^^^^
+.. _pyvista_docs: https://docs.pyvista.org/version/stable/
+.. _jupyter: https://jupyter.org/
+.. _numpy_org: https://numpy.org/
+.. _numpy_docs: https://numpy.org/doc/stable/
+
+External links
+^^^^^^^^^^^^^^
+.. _sphinx: https://www.sphinx-doc.org/en/master/
+.. _sphinx_directives: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
+.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/
+.. _vale: https://www.vale.sh
+.. _docutils_directives: https://docutils.sourceforge.io/docs/ref/rst/directives.html
+
+==========
+References
+==========
+
+Main DPF objects
+^^^^^^^^^^^^^^^^
+
+.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
+.. |Field| replace:: :class:`Field<ansys.dpf.core.field.Field>`
+.. |FieldsContainer| replace:: :class:`FieldsContainer<ansys.dpf.core.fields_container.FieldsContainer>`
+.. |Model| replace:: :class:`Model <ansys.dpf.core.model.Model>`
+.. |DataSources| replace:: :class:`Model <ansys.dpf.core.data_sources.DataSources>`
+.. |Scoping| replace:: :class:`Scoping <ansys.dpf.core.scoping.Scoping>`
+.. |MeshedRegion| replace:: :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>`
+.. |MeshInfo| replace:: :class:`MeshInfo <ansys.dpf.core.mesh_info.MeshInfo>`
+.. |Nodes| replace:: :class:`Nodes <ansys.dpf.core.nodes.Nodes>`
+.. |Elements| replace:: :class:`Elements <ansys.dpf.core.elements.Elements>`
+.. |Faces| replace:: :class:`Faces <ansys.dpf.core.faces.Faces>`
+.. |DpfPlotter| replace:: :class:`DpfPlotter<ansys.dpf.core.plotter.DpfPlotter>`
+.. |Result| replace:: :class:`Result <ansys.dpf.core.results.Result>`
+.. |Operator| replace:: :class:`Operator<ansys.dpf.core.dpf_operator.Operator>`
+.. |TimeFreqSupport| replace:: :class:`TimeFreqSupport <ansys.dpf.core.time_freq_support.TimeFreqSupport>`