diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index c1bb5eb1..dffc9e80 100644 --- 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/upload-artifact@v2.2.1 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 \ No newline at end of file diff --git a/.gitignore b/.gitignore index cc86700a..49e59b35 100755 --- 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 index 6532e5af..00dd7819 100644 --- 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 index 7df2742f..0e893133 100644 --- 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 b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/docs/source/api/archive.rst b/doc/source/api/archive.rst similarity index 100% rename from docs/source/api/archive.rst rename to doc/source/api/archive.rst diff --git a/docs/source/api/cyclic_result.rst b/doc/source/api/cyclic_result.rst similarity index 100% rename from docs/source/api/cyclic_result.rst rename to doc/source/api/cyclic_result.rst diff --git a/docs/source/api/emat.rst b/doc/source/api/emat.rst similarity index 100% rename from docs/source/api/emat.rst rename to doc/source/api/emat.rst diff --git a/docs/source/api/full.rst b/doc/source/api/full.rst similarity index 100% rename from docs/source/api/full.rst rename to doc/source/api/full.rst diff --git a/docs/source/api/index.rst b/doc/source/api/index.rst similarity index 100% rename from docs/source/api/index.rst rename to doc/source/api/index.rst diff --git a/docs/source/api/mesh_quality.rst b/doc/source/api/mesh_quality.rst similarity index 100% rename from docs/source/api/mesh_quality.rst rename to doc/source/api/mesh_quality.rst diff --git a/docs/source/api/rst.rst b/doc/source/api/rst.rst similarity index 100% rename from docs/source/api/rst.rst rename to doc/source/api/rst.rst diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 86% rename from docs/source/conf.py rename to doc/source/conf.py index 4f233d87..7947928f 100644 --- a/docs/source/conf.py +++ b/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 b/doc/source/contributing.rst similarity index 100% rename from docs/source/contributing.rst rename to doc/source/contributing.rst diff --git a/docs/source/getting_started.rst b/doc/source/getting_started.rst similarity index 100% rename from docs/source/getting_started.rst rename to doc/source/getting_started.rst diff --git a/docs/source/images/ansys_stress.png b/doc/source/images/ansys_stress.png similarity index 100% rename from docs/source/images/ansys_stress.png rename to doc/source/images/ansys_stress.png diff --git a/docs/source/images/beam_mode_shape.gif b/doc/source/images/beam_mode_shape.gif similarity index 100% rename from docs/source/images/beam_mode_shape.gif rename to doc/source/images/beam_mode_shape.gif diff --git a/docs/source/images/beam_mode_shape_small.gif b/doc/source/images/beam_mode_shape_small.gif similarity index 100% rename from docs/source/images/beam_mode_shape_small.gif rename to doc/source/images/beam_mode_shape_small.gif diff --git a/docs/source/images/beam_stress.png b/doc/source/images/beam_stress.png similarity index 100% rename from docs/source/images/beam_stress.png rename to doc/source/images/beam_stress.png diff --git a/docs/source/images/beam_stress_small.png b/doc/source/images/beam_stress_small.png similarity index 100% rename from docs/source/images/beam_stress_small.png rename to doc/source/images/beam_stress_small.png diff --git a/docs/source/images/cellqual.png b/doc/source/images/cellqual.png similarity index 100% rename from docs/source/images/cellqual.png rename to doc/source/images/cellqual.png diff --git a/docs/source/images/hexbeam.png b/doc/source/images/hexbeam.png similarity index 100% rename from docs/source/images/hexbeam.png rename to doc/source/images/hexbeam.png diff --git a/docs/source/images/hexbeam_disp.png b/doc/source/images/hexbeam_disp.png similarity index 100% rename from docs/source/images/hexbeam_disp.png rename to doc/source/images/hexbeam_disp.png diff --git a/docs/source/images/hexbeam_disp_small.png b/doc/source/images/hexbeam_disp_small.png similarity index 100% rename from docs/source/images/hexbeam_disp_small.png rename to doc/source/images/hexbeam_disp_small.png diff --git a/docs/source/images/hexbeam_small.png b/doc/source/images/hexbeam_small.png similarity index 100% rename from docs/source/images/hexbeam_small.png rename to doc/source/images/hexbeam_small.png diff --git a/docs/source/images/paraview.jpg b/doc/source/images/paraview.jpg similarity index 100% rename from docs/source/images/paraview.jpg rename to doc/source/images/paraview.jpg diff --git a/docs/source/images/rotor.jpg b/doc/source/images/rotor.jpg similarity index 100% rename from docs/source/images/rotor.jpg rename to doc/source/images/rotor.jpg diff --git a/docs/source/images/sector.jpg b/doc/source/images/sector.jpg similarity index 100% rename from docs/source/images/sector.jpg rename to doc/source/images/sector.jpg diff --git a/docs/source/images/solved_km.png b/doc/source/images/solved_km.png similarity index 100% rename from docs/source/images/solved_km.png rename to doc/source/images/solved_km.png diff --git a/docs/source/images/vplot_cylinder.png b/doc/source/images/vplot_cylinder.png similarity index 100% rename from docs/source/images/vplot_cylinder.png rename to doc/source/images/vplot_cylinder.png diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 100% rename from docs/source/index.rst rename to doc/source/index.rst diff --git a/docs/source/user_guide/archive.rst b/doc/source/user_guide/archive.rst similarity index 100% rename from docs/source/user_guide/archive.rst rename to doc/source/user_guide/archive.rst diff --git a/docs/source/user_guide/index.rst b/doc/source/user_guide/index.rst similarity index 100% rename from docs/source/user_guide/index.rst rename to doc/source/user_guide/index.rst diff --git a/docs/source/user_guide/loading_emat.rst b/doc/source/user_guide/loading_emat.rst similarity index 100% rename from docs/source/user_guide/loading_emat.rst rename to doc/source/user_guide/loading_emat.rst diff --git a/docs/source/user_guide/loading_km.rst b/doc/source/user_guide/loading_km.rst similarity index 100% rename from docs/source/user_guide/loading_km.rst rename to doc/source/user_guide/loading_km.rst diff --git a/docs/source/user_guide/loading_results.rst b/doc/source/user_guide/loading_results.rst similarity index 100% rename from docs/source/user_guide/loading_results.rst rename to doc/source/user_guide/loading_results.rst diff --git a/docs/source/user_guide/quality.rst b/doc/source/user_guide/quality.rst similarity index 100% rename from docs/source/user_guide/quality.rst rename to doc/source/user_guide/quality.rst diff --git a/docs/source/Makefile b/docs/source/Makefile deleted file mode 100644 index 75cfabb3..00000000 --- a/docs/source/Makefile +++ /dev/null @@ -1,25 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = python3.7 -msphinx -SPHINXPROJ = pyansys -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -clean: - rm -rf $(BUILDDIR)/* - rm -rf examples/ - rm -f errors.txt - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/source/_static/css/ansys.css b/docs/source/_static/css/ansys.css deleted file mode 100644 index 9586a07b..00000000 --- a/docs/source/_static/css/ansys.css +++ /dev/null @@ -1,72 +0,0 @@ -:root { - --ansysGold: #FFB71B; - --ansysBronze: #C89211; - --pythonBlue: #3972a1; -} - -body { - font-family: 'Source Sans Pro', sans-serif; - color: black; -} - -h1, h2, h3, h4, h5, h6 { - color: var(--pythonBlue); - font-family: 'Source Sans Pro', sans-serif; -} - -.navbar-toggler-icon { - background-image: url("data:image/svg+xml;charset=utf8,%3Csvg viewBox='0 0 32 32' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath stroke='rgba(255,255,255, 0.9)' stroke-width='2' stroke-linecap='round' stroke-miterlimit='10' d='M4 8h24M4 16h24M4 24h24'/%3E%3C/svg%3E") !important; -} - -.sig-prename { - color: var(--ansysBronze); - font-family: 'Source Sans Pro', sans-serif; -} - -.sig-name { - color: var(--ansysBronze); - font-family: 'Source Sans Pro', sans-serif; -} - -.docutils { - color: var(--ansysBronze); - font-family: "Source Code Pro", "Courier New", monospace; -} - -.navbar-light { - background: black !important; -} - - -.navbar-light .navbar-nav .nav-link { - color: white; - font-family: 'Source Sans Pro', sans-serif; -} - -.navbar-light:hover .navbar-nav:hover .nav-link:hover { - color: var(--ansysGold); -} - -.navbar-nav>.active>.nav-link { - color: var(--ansysGold) !important; -} - -a.headerlink:hover { - background-color: var(--pythonBlue); -} - -a.headerlink { - /* background-color: var(--pythonBlue); */ - color: var(--pythonBlue); -} - - -@font-face { - font-family: "Source Sans Pro Light"; - src: url(../fonts/SourceSansPro-Light.ttf); -} - -@font-face { - font-family: "Source Sans Pro"; - src: url(../fonts/SourceSansPro-Regular.ttf); -} diff --git a/docs/source/_static/fonts/SourceSansPro-Light.ttf b/docs/source/_static/fonts/SourceSansPro-Light.ttf deleted file mode 100644 index 348871ac..00000000 Binary files a/docs/source/_static/fonts/SourceSansPro-Light.ttf and /dev/null differ diff --git a/docs/source/_static/fonts/SourceSansPro-Regular.ttf b/docs/source/_static/fonts/SourceSansPro-Regular.ttf deleted file mode 100644 index b422bf43..00000000 Binary files a/docs/source/_static/fonts/SourceSansPro-Regular.ttf and /dev/null differ diff --git a/docs/source/_static/fonts/SourceSansPro-SemiBold.ttf b/docs/source/_static/fonts/SourceSansPro-SemiBold.ttf deleted file mode 100644 index 2908e0d7..00000000 Binary files a/docs/source/_static/fonts/SourceSansPro-SemiBold.ttf and /dev/null differ diff --git a/docs/source/_static/pyansys-logo-black-cropped.png b/docs/source/_static/pyansys-logo-black-cropped.png deleted file mode 100644 index c3b671cf..00000000 Binary files a/docs/source/_static/pyansys-logo-black-cropped.png and /dev/null differ diff --git a/docs/source/_static/pyansys-logo-white-cropped.png b/docs/source/_static/pyansys-logo-white-cropped.png deleted file mode 100644 index af350200..00000000 Binary files a/docs/source/_static/pyansys-logo-white-cropped.png and /dev/null differ diff --git a/requirements_docs.txt b/requirements_docs.txt index 9d5b6204..903d0b03 100644 --- 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