Use PyANSYS Theme (#41)

ansys · Jun 12, 2021 · ccadf5b · ccadf5b
1 parent 8e35f0d
commit ccadf5b
Show file tree

Hide file tree

Showing 45 changed files with 21 additions and 129 deletions.
diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml
@@ -38,13 +38,13 @@ jobs:
         run: |
           sudo apt install pandoc -qy
           pip install -r requirements_docs.txt --disable-pip-version-check
-          make -C docs html
+          make -C doc html
   
       - name: Upload Documentation
         uses: actions/[email protected]
         with:
           name: Documentation
-          path: docs/build/html
+          path: doc/build/html
           retention-days: 7
 
       - name: Deploy
@@ -53,5 +53,5 @@ jobs:
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BRANCH: gh-pages
-          FOLDER: docs/build/html
+          FOLDER: doc/build/html
           CLEAN: true
diff --git a/.gitignore b/.gitignore
@@ -30,7 +30,7 @@ dist/
 _build/
 pyansys/Interface.py
 *.bat
-docs/source/examples/*
+doc/source/examples/*
 *.out
 *.tar.gz
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
-The MIT License
+MIT License
 
-Copyright (c) 2017-2020 The PyVista Developers
+Copyright (c) 2021 ANSYS, Inc. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Makefile b/Makefile
@@ -1,7 +1,7 @@
 # Simple makefile to simplify repetitive build env management tasks under posix
 
 CODESPELL_DIRS ?= ./
-CODESPELL_SKIP ?= "*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./docs/build/*,./docs/images/*,./dist/*,*~,.hypothesis*,./docs/source/examples/*,*cover,*.dat,*.mac,\#*,build,./docker/mapdl/v211,./factory/*,./ansys/mapdl/reader/cython/_reader.c,./ansys/mapdl/reader/cython/_binary_reader.cpp,./ansys/mapdl/reader/cython/_cellqual.c,,./ansys/mapdl/reader/cython/_relaxmidside.c,*.inp,_*.c*,*.mypy_cache/*,*.cdb"
+CODESPELL_SKIP ?= "*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,\#*,build,./docker/mapdl/v211,./factory/*,./ansys/mapdl/reader/cython/_reader.c,./ansys/mapdl/reader/cython/_binary_reader.cpp,./ansys/mapdl/reader/cython/_cellqual.c,,./ansys/mapdl/reader/cython/_relaxmidside.c,*.inp,_*.c*,*.mypy_cache/*,*.cdb,./doc/source/examples/*"
 CODESPELL_IGNORE ?= "ignore_words.txt"
 
 all: doctest

diff --git a/docs/Makefile → doc/Makefile b/docs/Makefile → doc/Makefile
diff --git a/docs/source/api/archive.rst → doc/source/api/archive.rst b/docs/source/api/archive.rst → doc/source/api/archive.rst
diff --git a/docs/source/api/cyclic_result.rst → doc/source/api/cyclic_result.rst b/docs/source/api/cyclic_result.rst → doc/source/api/cyclic_result.rst
diff --git a/docs/source/api/emat.rst → doc/source/api/emat.rst b/docs/source/api/emat.rst → doc/source/api/emat.rst
diff --git a/docs/source/api/full.rst → doc/source/api/full.rst b/docs/source/api/full.rst → doc/source/api/full.rst
diff --git a/docs/source/api/index.rst → doc/source/api/index.rst b/docs/source/api/index.rst → doc/source/api/index.rst
diff --git a/docs/source/api/mesh_quality.rst → doc/source/api/mesh_quality.rst b/docs/source/api/mesh_quality.rst → doc/source/api/mesh_quality.rst
diff --git a/docs/source/api/rst.rst → doc/source/api/rst.rst b/docs/source/api/rst.rst → doc/source/api/rst.rst
diff --git a/docs/source/conf.py → doc/source/conf.py b/docs/source/conf.py → doc/source/conf.py
@@ -64,9 +64,9 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'PyMAPDL Reader'
-copyright = u'2020, ANSYS Open Source Developers'
-author = u'ANSYS Open Source Developers'
+project = u'PyMAPDL Legacy Reader'
+copyright = '(c) 2021 ANSYS, Inc. All rights reserved'
+author = 'ANSYS Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -135,25 +135,14 @@
 }
 
 
-# -- Options for HTML output ----------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'pydata_sphinx_theme'
-html_logo = '_static/pyansys-logo-black-cropped.png'
+# -- Options for HTML output -------------------------------------------------
+html_theme = 'pyansys_sphinx_theme'
+html_logo = 'https://docs.pyansys.com/_static/pyansys-logo-black-cropped.png'
 html_theme_options = {
-    "github_url": "https://github.com/pyansys/pymapdl-reader",
-    # "show_toc_level": 1,
-    # "show_prev_next": False
+    "github_url": "https://github.com/pyansys/PyMAPDL",
 }
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-html_css_files = ['css/ansys.css']
-
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
@@ -184,7 +173,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'pymapdl_reader.tex', u'PyMAPDL Reader Documentation',
+    (master_doc, 'pymapdl_reader.tex', u'PyMAPDL Legacy Reader Documentation',
      u'ANSYS Open Source Developers', 'manual'),
 ]
 
@@ -194,7 +183,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'pymapdl_reader', u'PyMAPDL Reader Documentation',
+    (master_doc, 'pymapdl_reader', u'PyMAPDL Legacy Reader Documentation',
      [author], 1)
 ]
 

diff --git a/docs/source/contributing.rst → doc/source/contributing.rst b/docs/source/contributing.rst → doc/source/contributing.rst
diff --git a/docs/source/getting_started.rst → doc/source/getting_started.rst b/docs/source/getting_started.rst → doc/source/getting_started.rst
diff --git a/docs/source/images/ansys_stress.png → doc/source/images/ansys_stress.png b/docs/source/images/ansys_stress.png → doc/source/images/ansys_stress.png
diff --git a/docs/source/images/beam_mode_shape.gif → doc/source/images/beam_mode_shape.gif b/docs/source/images/beam_mode_shape.gif → doc/source/images/beam_mode_shape.gif
diff --git a/docs/source/images/beam_mode_shape_small.gif → doc/source/images/beam_mode_shape_small.gif b/docs/source/images/beam_mode_shape_small.gif → doc/source/images/beam_mode_shape_small.gif
diff --git a/docs/source/images/beam_stress.png → doc/source/images/beam_stress.png b/docs/source/images/beam_stress.png → doc/source/images/beam_stress.png
diff --git a/docs/source/images/beam_stress_small.png → doc/source/images/beam_stress_small.png b/docs/source/images/beam_stress_small.png → doc/source/images/beam_stress_small.png
diff --git a/docs/source/images/cellqual.png → doc/source/images/cellqual.png b/docs/source/images/cellqual.png → doc/source/images/cellqual.png
diff --git a/docs/source/images/hexbeam.png → doc/source/images/hexbeam.png b/docs/source/images/hexbeam.png → doc/source/images/hexbeam.png
diff --git a/docs/source/images/hexbeam_disp.png → doc/source/images/hexbeam_disp.png b/docs/source/images/hexbeam_disp.png → doc/source/images/hexbeam_disp.png
diff --git a/docs/source/images/hexbeam_disp_small.png → doc/source/images/hexbeam_disp_small.png b/docs/source/images/hexbeam_disp_small.png → doc/source/images/hexbeam_disp_small.png
diff --git a/docs/source/images/hexbeam_small.png → doc/source/images/hexbeam_small.png b/docs/source/images/hexbeam_small.png → doc/source/images/hexbeam_small.png
diff --git a/docs/source/images/paraview.jpg → doc/source/images/paraview.jpg b/docs/source/images/paraview.jpg → doc/source/images/paraview.jpg
diff --git a/docs/source/images/rotor.jpg → doc/source/images/rotor.jpg b/docs/source/images/rotor.jpg → doc/source/images/rotor.jpg
diff --git a/docs/source/images/sector.jpg → doc/source/images/sector.jpg b/docs/source/images/sector.jpg → doc/source/images/sector.jpg
diff --git a/docs/source/images/solved_km.png → doc/source/images/solved_km.png b/docs/source/images/solved_km.png → doc/source/images/solved_km.png
diff --git a/docs/source/images/vplot_cylinder.png → doc/source/images/vplot_cylinder.png b/docs/source/images/vplot_cylinder.png → doc/source/images/vplot_cylinder.png
diff --git a/docs/source/index.rst → doc/source/index.rst b/docs/source/index.rst → doc/source/index.rst
diff --git a/docs/source/user_guide/archive.rst → doc/source/user_guide/archive.rst b/docs/source/user_guide/archive.rst → doc/source/user_guide/archive.rst
diff --git a/docs/source/user_guide/index.rst → doc/source/user_guide/index.rst b/docs/source/user_guide/index.rst → doc/source/user_guide/index.rst
diff --git a/docs/source/user_guide/loading_emat.rst → doc/source/user_guide/loading_emat.rst b/docs/source/user_guide/loading_emat.rst → doc/source/user_guide/loading_emat.rst
diff --git a/docs/source/user_guide/loading_km.rst → doc/source/user_guide/loading_km.rst b/docs/source/user_guide/loading_km.rst → doc/source/user_guide/loading_km.rst
diff --git a/docs/source/user_guide/loading_results.rst → doc/source/user_guide/loading_results.rst b/docs/source/user_guide/loading_results.rst → doc/source/user_guide/loading_results.rst
diff --git a/docs/source/user_guide/quality.rst → doc/source/user_guide/quality.rst b/docs/source/user_guide/quality.rst → doc/source/user_guide/quality.rst
diff --git a/docs/source/Makefile b/docs/source/Makefile
diff --git a/docs/source/_static/css/ansys.css b/docs/source/_static/css/ansys.css
diff --git a/docs/source/_static/fonts/SourceSansPro-Light.ttf b/docs/source/_static/fonts/SourceSansPro-Light.ttf
diff --git a/docs/source/_static/fonts/SourceSansPro-Regular.ttf b/docs/source/_static/fonts/SourceSansPro-Regular.ttf
diff --git a/docs/source/_static/fonts/SourceSansPro-SemiBold.ttf b/docs/source/_static/fonts/SourceSansPro-SemiBold.ttf
diff --git a/docs/source/_static/pyansys-logo-black-cropped.png b/docs/source/_static/pyansys-logo-black-cropped.png
diff --git a/docs/source/_static/pyansys-logo-white-cropped.png b/docs/source/_static/pyansys-logo-white-cropped.png
diff --git a/requirements_docs.txt b/requirements_docs.txt
@@ -10,5 +10,5 @@ pytest-sphinx
 sphinx-notfound-page>=0.3.0
 sphinx-copybutton
 sphinx-gallery>=0.8.1
-pydata-sphinx-theme
+pyansys_sphinx_theme
 pypandoc