-
Notifications
You must be signed in to change notification settings - Fork 64
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
Updated the design and the logo in documentation #268
Closed
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,4 +7,3 @@ CartesianDomain | |
.. autoclass:: CartesianDomain | ||
:members: | ||
:show-inheritance: | ||
:noindex: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,4 +7,3 @@ EllipsoidDomain | |
.. autoclass:: EllipsoidDomain | ||
:members: | ||
:show-inheritance: | ||
:noindex: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,4 +7,3 @@ SimplexDomain | |
.. autoclass:: SimplexDomain | ||
:members: | ||
:show-inheritance: | ||
:noindex: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
InverseProblem | ||
================ | ||
.. currentmodule:: pina.problem.inverse_problem | ||
|
||
.. automodule:: pina.problem.inverse_problem | ||
|
||
.. autoclass:: InverseProblem | ||
:members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,13 +15,16 @@ | |
import sys | ||
import os | ||
import sphinx_rtd_theme | ||
|
||
# If extensions (or modules to document with autodoc) are in another directory, | ||
# add these directories to sys.path here. If the directory is relative to the | ||
# documentation root, use os.path.abspath to make it absolute, like shown here. | ||
sys.path.insert(0, os.path.abspath('../..')) | ||
import pina | ||
|
||
# -- Project information ----------------------------------------------------- | ||
|
||
project = pina.__project__ | ||
copyright = pina.__copyright__ | ||
author = pina.__author__ | ||
version = release ='1.0.0' | ||
|
||
|
||
sys.path.insert(0, os.path.abspath('../sphinx_extensions')) # extension to remove paramref link from lightinig | ||
|
||
# -- General configuration ------------------------------------------------ | ||
|
@@ -51,6 +54,21 @@ | |
'sphinx_copybutton', | ||
] | ||
|
||
# The root document. | ||
root_doc = 'index' | ||
|
||
# List of patterns, relative to source directory, that match files and | ||
# directories to ignore when looking for source files. | ||
# This pattern also affects html_static_path and html_extra_path. | ||
exclude_patterns = ['_build', 'docstrings', 'nextgen', 'Thumbs.db', '.DS_Store'] | ||
|
||
# The reST default role (used for this markup: `text`) to use for all documents. | ||
default_role = 'literal' | ||
|
||
# Generate the API documentation when building | ||
autosummary_generate = True | ||
numpydoc_show_class_members = False | ||
|
||
intersphinx_mapping = { | ||
'python': ('http://docs.python.org/3', None), | ||
# 'numpy': ('http://docs.scipy.org/doc/numpy/', None), | ||
|
@@ -68,7 +86,6 @@ | |
('py:func', 'torch.inference_mode'), | ||
('py:func', 'torch.no_grad'), | ||
('py:class', 'torch.utils.data.DistributedSampler'), | ||
('py:class', 'CartesianDomain'), # TO FIX | ||
('py:class', 'pina.model.layers.convolution.BaseContinuousConv'), | ||
('py:class', 'Module'), | ||
('py:class', 'torch.nn.modules.loss._Loss'), # TO FIX | ||
|
@@ -162,7 +179,7 @@ | |
|
||
# The theme to use for HTML and HTML Help pages. See the documentation for | ||
# a list of builtin themes. | ||
html_theme = "sphinx_rtd_theme" | ||
html_theme = 'pydata_sphinx_theme' | ||
|
||
# Theme options are theme-specific and customize the look and feel of a theme | ||
# further. For a list of options available for each theme, see the | ||
|
@@ -181,12 +198,32 @@ | |
|
||
# The name of an image file (relative to this directory) to place at the top | ||
# of the sidebar. | ||
html_logo = "index_files/pina_logo.png" | ||
html_logo = "index_files/pina_logo_pina.png" | ||
html_theme_options = { | ||
'logo_only': True, | ||
'display_version': True, | ||
'prev_next_buttons_location': 'bottom', | ||
|
||
"icon_links": [ | ||
{ | ||
"name": "GitHub", | ||
"url": "https://github.com/mathLab/PINA", | ||
"icon": "fab fa-github", | ||
"type": "fontawesome", | ||
}, | ||
{ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @ZahraMirzaiyan please remove it for now |
||
"name": "StackOverflow", | ||
"url": "https://github.com/mathLab/PINA", | ||
"icon": "fab fa-stack-overflow", | ||
"type": "fontawesome", | ||
}, | ||
{ | ||
"name": "Twitter", | ||
"url": "http://twitter.com/rozzagroup", | ||
"icon": "fab fa-twitter", | ||
"type": "fontawesome", | ||
}, | ||
], | ||
"show_prev_next": False, | ||
"navbar_start": ["navbar-logo"], | ||
"navbar_end": ["navbar-icon-links"], | ||
"header_links_before_dropdown": 8, | ||
} | ||
|
||
# The name of an image file (within the static path) to use as favicon of the | ||
|
@@ -195,8 +232,7 @@ | |
# html_favicon = None | ||
|
||
# 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". | ||
# 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'] | ||
|
||
# Add any extra paths that contain custom files (such as robots.txt or | ||
|
@@ -342,4 +378,4 @@ | |
|
||
# If true, do not generate a @detailmenu in the "Top" node's menu. | ||
# texinfo_no_detailmenu = False | ||
autodoc_member_order = 'bysource' | ||
autodoc_member_order = 'bysource' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is this needed @ZahraMirzaiyan ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need! Deleted for now.