Feat/generalize to ansys theme (#58)

* rename the theme to ansys-sphinx-theme

* add ansys logo to the theme

* Update readme to ansys

* Update readme for ansys-sphinx-theme

* rename css file to ansys-sphinx-theme

* rename to ansys sphinx theme in doc files

* rename pyansys to ansys in workflow an makefile

* Apply suggestions from code review

Co-authored-by: Alex Kaszynski <[email protected]>

* Update Makefile

Co-authored-by: Alex Kaszynski <[email protected]>

* update makefile for pdf

* Apply suggestions from code review

Co-authored-by: Jorge Martínez <[email protected]>

* update target and name for badge.

Co-authored-by: Alex Kaszynski <[email protected]>
Co-authored-by: Jorge Martínez <[email protected]>

Author: 3 people

.github/workflows/ci_cd.yml

@@ -60,7 +60,7 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: PDF-Documentation
-          path: doc/build/latex/pyansys*.pdf
+          path: doc/build/latex/ansys_sphinx_theme.pdf
           retention-days: 7
 
       - name: Deploy to gh-pages
@@ -92,7 +92,7 @@ jobs:
       - name: Upload wheel and sdist to artifacts
         uses: actions/upload-artifact@v2
         with:
-          name: pyasys-sphinx-theme
+          name: ansys-sphinx-theme
           path: dist/
           retention-days: 7
 
@@ -126,7 +126,7 @@ jobs:
           files: |
             ./**/*.whl
             ./**/*.tar.gz
-            ./PDF-Documentation/pyansys_sphinx_theme.pdf
+            ./PDF-Documentation/ansys_sphinx_theme.pdf
       - name: Release
         uses: softprops/action-gh-release@v1
         with:

README.rst

@@ -1,10 +1,10 @@
-PyAnsys Sphinx Theme
-====================
+Ansys Sphinx Theme
+==================
 |pyansys| |python| |pypi| |GH-CI| |MIT| |black|
 
 .. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
-   :target: https://docs.pyansys.com/
-   :alt: PyAnsys
+   :target: https://ansys.github.io/
+   :alt: Ansys
 
 .. |python| image:: https://img.shields.io/badge/Python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue
    :target: https://pypi.org/project/pyansys-sphinx-theme/
@@ -29,7 +29,7 @@ PyAnsys Sphinx Theme
 
 Introduction and Purpose
 ------------------------
-The PyAnsys Sphinx theme is an extension of the popular `PyData
+The Ansys Sphinx theme is an extension of the popular `PyData
 Sphinx Theme <https://pydata-sphinx-theme.readthedocs.io/>`_ used by
 `numpy <https://numpy.org/doc/stable/>`_, `pandas
 <https://pandas.pydata.org/docs/>`_, `PyVista
@@ -41,10 +41,10 @@ consistently.
 Documentation
 ~~~~~~~~~~~~~
 Full documentation can be found at `PyAnsys Sphinx Theme Documentation <https://sphinxdocs.pyansys.com>`_. The webpage was
-also built using the ``pyansys-sphinx-theme``, so visit the site for a
+also built using the ``ansys-sphinx-theme``, so visit the site for a
 preview of the theme.
 
-Other PyAnsys packages using the PyAnsys theme include:
+Other PyAnsys packages using the Ansys theme include:
 
 - `PyMAPDL <https://mapdldocs.pyansys.com/>`__
 - `PyAEDT <https://aedtdocs.pyansys.com/>`__
@@ -59,10 +59,10 @@ Install this theme with:
 
 .. code::
 
-   pip install pyansys-sphinx-theme
+   pip install ansys-sphinx-theme
 
 Next, modify your sphinx ``conf.py`` to use ``html_theme =
-'pyansys_sphinx_theme'``.  If you are new to using
+'ansys_sphinx_theme'``.  If you are new to using
 Sphinx, see `Sphinx Getting Started
 <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_
 documentation.

doc/Makefile

@@ -27,4 +27,4 @@ clean:
 pdf:
 	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	cd build/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
-	(test -f build/latex/pyansys*.pdf && echo pdf exists) || exit 1
+	(test -f build/latex/ansys_sphinx*.pdf && echo pdf exists) || exit 1

doc/make.bat

@@ -35,7 +35,7 @@ goto end
 :pdf
 	%SPHINXBUILD% -M latex %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 	cd "%BUILDDIR%\latex"
-	pdflatex pyansys_sphinx_theme.tex --interaction=nonstopmode
+	pdflatex ansys_sphinx_theme.tex --interaction=nonstopmode
 
 :end
 popd

doc/source/class_documentation.rst

@@ -43,11 +43,11 @@ using the ``autoclass`` directive:
 
 .. code::
 
-   .. autoclass:: pyansys_sphinx_theme.samples.ExampleClass
+   .. autoclass:: ansys_sphinx_theme.samples.ExampleClass
        :members:
 
 
-.. autoclass:: pyansys_sphinx_theme.samples.ExampleClass
+.. autoclass:: ansys_sphinx_theme.samples.ExampleClass
     :members:
 
 
@@ -63,15 +63,15 @@ documented via the ``autosummary`` directive.  For example:
    .. autosummary::
       :toctree: _autosummary
 
-      pyansys_sphinx_theme.samples.Complex
+      ansys_sphinx_theme.samples.Complex
 
 
 This code will generate the following documentation:
 
 .. autosummary::
    :toctree: _autosummary
 
-   pyansys_sphinx_theme.samples.Complex
+   ansys_sphinx_theme.samples.Complex
 
 Each class will have its own dedicated page, and each method and
 attribute in that class will also have its own page.

doc/source/conf.py

@@ -5,25 +5,25 @@
 
 LaTeXBuilder.supported_image_types = ["image/png", "image/pdf", "image/svg+xml"]
 
-from pyansys_sphinx_theme import (
+from ansys_sphinx_theme import (
     __version__,
     ansys_favicon,
+    ansys_logo_black,
     ansys_logo_white,
     ansys_logo_white_cropped,
     latex,
-    pyansys_logo_black,
     watermark,
 )
 
 # Project information
-project = "pyansys_sphinx_theme"
+project = "ansys_sphinx_theme"
 copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
 author = "Ansys Inc."
 release = version = __version__
 
-# use the default pyansys logo
-html_logo = pyansys_logo_black
-html_theme = "pyansys_sphinx_theme"
+# use the default ansys logo
+html_logo = ansys_logo_black
+html_theme = "ansys_sphinx_theme"
 
 # specify the location of your github repo
 html_theme_options = {
@@ -33,7 +33,7 @@
     ],
 }
 
-html_short_title = html_title = "PyAnsys Sphinx Theme"
+html_short_title = html_title = "Ansys Sphinx Theme"
 
 # Sphinx extensions
 extensions = [
@@ -42,6 +42,7 @@
     "numpydoc",
     "sphinx.ext.intersphinx",
     "sphinx_copybutton",
+    "ansys_sphinx_theme",
 ]
 
 # Intersphinx mapping

doc/source/index.rst

@@ -1,6 +1,6 @@
-============================================
-PyAnsys Sphinx Theme Documentation |version|
-============================================
+==========================================
+Ansys Sphinx Theme Documentation |version|
+==========================================
 
 ..
    Simply reuse the root readme
@@ -20,7 +20,7 @@ PyAnsys Sphinx Theme Documentation |version|
 Code Examples
 ~~~~~~~~~~~~~
 Here's a quick preview for how Python code looks using the
-``pyansys-sphinx-theme``.  For more examples, click the links at the
+``ansys-sphinx-theme``.  For more examples, click the links at the
 top of the page to see function, method, and class documentation.
 
 

doc/source/style.rst

@@ -12,18 +12,18 @@ Methods and functions should generally be documented with the
 ``Examples`` docstring section to make the usage of the method or
 function clear.  Here is a sample function:
 
-.. literalinclude:: ../../src/pyansys_sphinx_theme/sample_func.py
+.. literalinclude:: ../../src/ansys_sphinx_theme/sample_func.py
 
 To include the docstring of function within sphinx, use the
 ``autofunction::`` directive:
 
 .. code::
 
-   .. autofunction:: pyansys_sphinx_theme.sample_func.func
+   .. autofunction:: ansys_sphinx_theme.sample_func.func
 
 Which causes the function to be rendered as:
 
-.. autofunction:: pyansys_sphinx_theme.sample_func.func
+.. autofunction:: ansys_sphinx_theme.sample_func.func
 
 
 More Details

doc/source/usage.rst

@@ -6,13 +6,13 @@ Install this theme with:
 
 .. code::
 
-   pip install pyansys-sphinx-theme
+   pip install ansys-sphinx-theme
 
 If you are are new to Sphinx, see the
 `Sphinx Getting Started
 <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_ documentation.
 Next, modify your Sphinx ``conf.py`` file to use ``html_theme =
-'pyansys_sphinx_theme'``. Consider using the following ``conf.py`` for this repository:
+'ansys_sphinx_theme'``. Consider using the following ``conf.py`` for this repository:
 
 .. literalinclude:: ./conf.py
    :language: python
@@ -21,7 +21,7 @@ Next, modify your Sphinx ``conf.py`` file to use ``html_theme =
 For additional configuration options, see the `Configuration
 <https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/configuring.html>`_
 topic for the PyData Sphinx theme, which is the basis for the style of this 
-PyAnsys theme.
+theme.
 
 
 Editing the CSS
@@ -58,13 +58,13 @@ Use your ``custom.css`` file to override the CSS style of this theme.
 
 Adding Breadcrumbs
 ~~~~~~~~~~~~~~~~~~
-The PyAnsys Sphinx theme supports the display of breadcrumbs on
+The ``ansys-sphinx-theme`` supports the display of breadcrumbs on
 the body of documentation pages to make navigation easier. These 
 breadcrumbs are disabled by default. To add
 breadcrumbs to the pages of your documentation, in the ``conf.py``
 file, add ``"show_breadcrumbs": True`` to the ``html_theme_options`` dictionary.
 
-If you want to add additional 'root' breadcrumbs, such as to the PyAnsys
+If you want to add additional 'root' breadcrumbs, such as to the Ansys
 Documentation homepage, add them to the ``html_theme_options`` dictionary as a
 list of tuples with the ``"additional_breadcrumbs"`` key. The tuples are of the
 form ``("Link text", "url")``.
@@ -90,7 +90,7 @@ the title of the ``index.rst`` page. For example:
 
 .. code:: python
 
-   html_short_title = html_title = 'PyAnsys Sphinx Theme'
+   html_short_title = html_title = 'Ansys Sphinx Theme'
 
 If you want to use the version number in
 the ``index.rst`` title, use ``|version|`` to include the package version

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
-name = "pyansys-sphinx-theme"
+name = "ansys-sphinx-theme"
 dynamic = ["version", "description"]
 readme = "README.rst"
 requires-python = ">=3.5"
@@ -30,19 +30,19 @@ dependencies = [
 ]
 
 [project.entry-points."sphinx.html_themes"]
-pyansys_sphinx_theme = "pyansys_sphinx_theme"
+ansys_sphinx_theme = "ansys_sphinx_theme"
 
 [tool.flit.module]
-name = "pyansys_sphinx_theme"
+name = "ansys_sphinx_theme"
 
 [tool.flit.sdist]
 include = [
-    "src/pyansys_sphinx_theme/layout.html",
-    "src/pyansys_sphinx_theme/breadcrumbs.html",
-    "src/pyansys_sphinx_theme/docs-navbar.html",
-    "src/pyansys_sphinx_theme/theme.conf",
-    "src/pyansys_sphinx_theme/_templates/",
-    "src/pyansys_sphinx_theme/static/",
+    "src/ansys_sphinx_theme/layout.html",
+    "src/ansys_sphinx_theme/breadcrumbs.html",
+    "src/ansys_sphinx_theme/docs-navbar.html",
+    "src/ansys_sphinx_theme/theme.conf",
+    "src/ansys_sphinx_theme/_templates/",
+    "src/ansys_sphinx_theme/static/",
 ]
 
 [project.urls]