Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use PyANSYS Theme #41

Merged
merged 21 commits into from
Jun 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/doc-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -53,5 +53,5 @@ jobs:
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: docs/build/html
FOLDER: doc/build/html
CLEAN: true
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ dist/
_build/
pyansys/Interface.py
*.bat
docs/source/examples/*
doc/source/examples/*
*.out
*.tar.gz

Expand Down
12 changes: 6 additions & 6 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
29 changes: 9 additions & 20 deletions docs/source/conf.py → doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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'),
]

Expand All @@ -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)
]

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
25 changes: 0 additions & 25 deletions docs/source/Makefile

This file was deleted.

72 changes: 0 additions & 72 deletions docs/source/_static/css/ansys.css

This file was deleted.

Binary file removed docs/source/_static/fonts/SourceSansPro-Light.ttf
Binary file not shown.
Binary file removed docs/source/_static/fonts/SourceSansPro-Regular.ttf
Binary file not shown.
Binary file not shown.
Binary file removed docs/source/_static/pyansys-logo-black-cropped.png
Binary file not shown.
Binary file removed docs/source/_static/pyansys-logo-white-cropped.png
Binary file not shown.
2 changes: 1 addition & 1 deletion requirements_docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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