ENH: new How-To chapter (#100)

* Rename guidelines/ -> how-to/

* Add setting-up section

* Add releasing section

* Apply suggestions from code review

Co-authored-by: Kathy Pippert <[email protected]>

* Link to CI section

* Finished releasing section

* Add contributing section

* Add supporting python versions section

* Review logging section

* Review documentation section

* Reformat testing section

* Improve continuous integration section

* Enhance documenting section

* Fix LaTeX math

* Apply suggestions from code review

Co-authored-by: German <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>

* Fix image filename

* Add MAIN_PYTHON_VERSION in workflow files

* Fix image filename

* Fix admonition indentation

* Turn CMD and PS as nested Windows tabs

* Reorder git config explanation

* Fix typo

* Guide for auto-delete PR branches

* Apply suggestions from code review

Co-authored-by: Kathy Pippert <[email protected]>

* Adapt to ansys-sphinx-theme

* Add non-interaction mode for latex

* Guide for non interaction of pdf build.

* change url of ansys-sphinx-theme

* Split into HTML and PDF build

* Suggestions to continuous-integration.rst

Co-authored-by: Kathy Pippert <[email protected]>

* Apply code suggestions

Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: German <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: Revathyvenugopal162 <[email protected]>

Author: 5 people

.gitignore

@@ -18,4 +18,4 @@ doc/build/
 venv/
 
 # sphinx autogen
-doc/source/guidelines/api/*
+doc/source/how-to/api/*

doc/source/coding-style/required-standard.rst

@@ -88,7 +88,7 @@ You can take advantage of :ref:`Pre-Commit` by including a
 
 GitHub CI/CD integration
 ------------------------
-Finally, you can take advantage of :ref:`Unit Testing on GitHub via CI/CD` and
+Finally, you can take advantage of :ref:`Testing Using GitHub Actions` and
 create a ``style.yml`` workflow file in ``.github/workflows/``:
 
 .. code-block:: yaml

doc/source/conf.py

@@ -99,15 +99,22 @@
 
 # Do not include the following patterns as documentation source files.
 # See issue: https://github.com/sphinx-doc/sphinx/issues/1668
-exclude_patterns = ["packaging/diag/*", "packaging/code/*"]
+exclude_patterns = [
+    "packaging/diag/*",
+    "packaging/code/*",
+    "how-to/diag/*",
+    "how-to/api/ansys_sphinx_theme.samples.Complex.abs.rst",
+    "how-to/api/ansys_sphinx_theme.samples.Complex.imag.rst",
+    "how-to/api/ansys_sphinx_theme.samples.Complex.real.rst",
+]
 
 # Fix excessive margins in mermaid output.
 # See issue: https://github.com/mermaid-js/mermaid/issues/1800#issuecomment-741617143
 mermaid_output_format = "png"
 mermaid_params = ["--width", "2000"]
 
-# Generate section labels up to three levels deep
-autosectionlabel_maxdepth = 3
+# Generate section labels up to four levels deep
+autosectionlabel_maxdepth = 4
 
 # TODO: warning suppression is temporary till https://github.com/pyansys/dev-guide/issues/64
 # gets fully implemented.

doc/source/doc-style/index.rst

@@ -31,7 +31,7 @@ The documentation for a PyAnsys library should contain:
 Finally, the documentation should be public and hosted via gh-pages, either as
 a branch named ``gh-pages`` within the library repository or within a
 ``gh-pages`` branch within ``<library-repository>-docs``. For more information,
-see :ref:`Continuous Documentation Deployment`.
+see :ref:`Deploying Documentation`.
 
 .. toctree::
    :hidden: