feat: doc getting started user guide email

ansys · Jul 20, 2023 · 2c3c870 · 2c3c870
1 parent 357d39f
commit 2c3c870
Show file tree

Hide file tree

Showing 13 changed files with 106 additions and 4 deletions.
diff --git a/doc/source/examples/basic-usage.rst b/doc/source/examples/basic-usage.rst
@@ -0,0 +1,10 @@
+.. _ref_basic-usage::
+
+===========
+Basic Usage
+===========
+
+.. automodule:: examples.basic-usage
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/doc/source/examples/index.rst b/doc/source/examples/index.rst
@@ -0,0 +1,13 @@
+.. _examples:
+
+========
+Examples
+========
+End-to-end examples show how you can use PyUnits. If the PyUnits ``ansys-units`` package is installed on your machine,
+you can download these examples as Python files or Jupyter notebooks and run them locally.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   basic-usage
diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst
@@ -1,4 +1,4 @@
-.. installation:
+.. _installation:
 
 ============
 Installation

diff --git a/doc/source/user_guide/config.rst b/doc/source/user_guide/config.rst
@@ -0,0 +1,5 @@
+.. _ref_config:
+
+===========
+Config YAML
+===========
diff --git a/doc/source/user_guide/dimensions.rst b/doc/source/user_guide/dimensions.rst
@@ -0,0 +1,11 @@
+.. _ref_dimensions:
+
+==========
+Dimensions
+==========
+
+.. automodule:: ansys.units.dimensions
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__, __init__, DimensionsError
diff --git a/doc/source/user_guide/map.rst b/doc/source/user_guide/map.rst
@@ -0,0 +1,11 @@
+.. _ref_map:
+
+============
+Quantity Map
+============
+
+.. automodule:: ansys.units.map
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__, __init__, QuantityMapError
diff --git a/doc/source/user_guide/quantity.rst b/doc/source/user_guide/quantity.rst
@@ -0,0 +1,11 @@
+.. _ref_quantity:
+
+========
+Quantity
+========
+
+.. automodule:: ansys.units.quantity
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__, __init__, QuantityError
diff --git a/doc/source/user_guide/systems.rst b/doc/source/user_guide/systems.rst
@@ -0,0 +1,11 @@
+.. _ref_systems:
+
+============
+Unit Systems
+============
+
+.. automodule:: ansys.units.systems
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__, __init__, UnitSystemError
diff --git a/doc/source/user_guide/tables.rst b/doc/source/user_guide/tables.rst
@@ -0,0 +1,11 @@
+.. _ref_tables:
+
+======
+Tables
+======
+
+.. automodule:: ansys.units.tables
+   :members:
+   :show-inheritance:
+   :undoc-members:
+   :exclude-members: __weakref__, __dict__, __init__
diff --git a/examples/00-Units/README.rst b/examples/00-Units/README.rst
@@ -0,0 +1,7 @@
+PyUnits Examples
+================
+PyUnits provides a pythonic interface for units, unit systems, and unit conversions.
+Its features enable seamless setup and usage of physical quantities. This includes 
+creating quantities, accessing different quantity properties, performing arithmetic 
+operations, performing unit conversions, creating unit systems, applying unit systems 
+to quantities.
diff --git a/examples/README.md b/examples/README.md
diff --git a/examples/README.rst b/examples/README.rst
@@ -0,0 +1,13 @@
+.. _ref_example_gallery:
+
+========
+Examples
+========
+End-to-end examples show how you can use PyUnits. If the PyFluent ``ansys-units`` package is installed on your machine,
+you can download these examples as Python files or Jupyter notebooks and run them locally.
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+.. 00-fluent/README.rst
diff --git a/src/ansys/units/quantity.py b/src/ansys/units/quantity.py
@@ -3,8 +3,8 @@
 
 class Quantity(float):
     """Quantity instantiates physical quantities using their real values and units. All
-    the instances of this class are converted to base SI units system to have
-    consistency in arithmetic operations.
+    instances of this class are converted to base SI units to have consistency in
+    arithmetic operations.
 
     Parameters
     ----------