Skip to content

Commit d596f0a

Browse files
Add a links and refs file to be used in the doc (#1940)
* add a file with refs and links to be used in the doc * add a file with refs and links to be used in the doc
1 parent bb6b859 commit d596f0a

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

doc/source/links_and_refs.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. _ref_links_and_refs:
2+
3+
.. LINKS
4+
5+
.. Pyansys
6+
.. _pyansys: https://docs.pyansys.com/version/dev/
7+
8+
.. PyAnsys Developer Guide
9+
.. _dev_guide_pyansys: https://dev.docs.pyansys.com
10+
.. _dev_guide_contributing: https://dev.docs.pyansys.com/how-to/contributing.html
11+
.. _dev_guide_coding_style: https://dev.docs.pyansys.com/coding-style/index.html
12+
.. _dev_guide_setup_your_environment: https://dev.docs.pyansys.com/how-to/setting-up.html
13+
.. _dev_guide_branch_names: https://dev.docs.pyansys.com/how-to/contributing.html#branch-naming-conventions
14+
.. _dev_guide_commit_names: https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions
15+
16+
.. Other libraries
17+
.. _pyvista_docs: https://docs.pyvista.org/version/stable/
18+
.. _jupyter: https://jupyter.org/
19+
.. _numpy_org: https://numpy.org/
20+
.. _numpy_docs: https://numpy.org/doc/stable/
21+
22+
.. External links
23+
.. _sphinx: https://www.sphinx-doc.org/en/master/
24+
.. _sphinx_directives: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
25+
.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/
26+
.. _vale: https://www.vale.sh
27+
.. _docutils_directives: https://docutils.sourceforge.io/docs/ref/rst/directives.html
28+
29+
.. REFERENCES
30+
31+
.. Main DPF objects
32+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
33+
.. |Field| replace:: :class:`Field<ansys.dpf.core.field.Field>`
34+
.. |FieldsContainer| replace:: :class:`FieldsContainer<ansys.dpf.core.fields_container.FieldsContainer>`
35+
.. |Model| replace:: :class:`Model <ansys.dpf.core.model.Model>`
36+
.. |DataSources| replace:: :class:`Model <ansys.dpf.core.data_sources.DataSources>`
37+
.. |Scoping| replace:: :class:`Scoping <ansys.dpf.core.scoping.Scoping>`
38+
.. |MeshedRegion| replace:: :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>`
39+
.. |MeshInfo| replace:: :class:`MeshInfo <ansys.dpf.core.mesh_info.MeshInfo>`
40+
.. |Nodes| replace:: :class:`Nodes <ansys.dpf.core.nodes.Nodes>`
41+
.. |Elements| replace:: :class:`Elements <ansys.dpf.core.elements.Elements>`
42+
.. |Faces| replace:: :class:`Faces <ansys.dpf.core.faces.Faces>`
43+
.. |DpfPlotter| replace:: :class:`DpfPlotter<ansys.dpf.core.plotter.DpfPlotter>`
44+
.. |Result| replace:: :class:`Result <ansys.dpf.core.results.Result>`
45+
.. |Operator| replace:: :class:`Operator<ansys.dpf.core.dpf_operator.Operator>`
46+
.. |TimeFreqSupport| replace:: :class:`TimeFreqSupport <ansys.dpf.core.time_freq_support.TimeFreqSupport>`

0 commit comments

Comments
 (0)