Skip to content

Commit 82e99a5

Browse files
LeguarkLeguark
committed
[META] Get the correct version of the documentation
1 parent e4bf1ee commit 82e99a5

File tree

2 files changed

+66
-66
lines changed

2 files changed

+66
-66
lines changed

‎docs/source/conf.py

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -50,41 +50,41 @@
5050
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
5151
# ones.
5252
extensions = [
53-
'sphinx.ext.autodoc',
54-
'sphinx.ext.autosummary',
55-
'sphinx.ext.doctest',
56-
'sphinx.ext.intersphinx',
57-
'sphinx.ext.todo',
58-
'sphinx.ext.coverage',
59-
'sphinx.ext.mathjax',
60-
'sphinx.ext.viewcode',
61-
'sphinx.ext.githubpages',
62-
'sphinx.ext.napoleon',
63-
'sphinx_gallery.gen_gallery',
53+
'sphinx.ext.autodoc',
54+
'sphinx.ext.autosummary',
55+
'sphinx.ext.doctest',
56+
'sphinx.ext.intersphinx',
57+
'sphinx.ext.todo',
58+
'sphinx.ext.coverage',
59+
'sphinx.ext.mathjax',
60+
'sphinx.ext.viewcode',
61+
'sphinx.ext.githubpages',
62+
'sphinx.ext.napoleon',
63+
'sphinx_gallery.gen_gallery',
6464
]
6565

6666
if run_intersphinx := False: # Example configuration for intersphinx: refer to the Python standard library.
6767
intersphinx_mapping = {
68-
'numpy' : ('https://numpy.org/doc/stable/', None),
69-
'python' : ('https://docs.python.org/{.major}'.format(sys.version_info), None),
70-
'matplotlib': ('https://matplotlib.org/stable/', None),
71-
'mayavi' : ('http://docs.enthought.com/mayavi/mayavi', None),
72-
'sklearn' : ('https://scikit-learn.org/stable', None),
73-
'skimage' : ('https://scikit-image.org/docs/dev/', None),
74-
'pyvista' : ('https://docs.pyvista.org/', None),
75-
'sphinx' : ('https://www.sphinx-doc.org/en/master/', None),
76-
'pandas' : ('https://pandas.pydata.org/pandas-docs/stable/', None),
68+
'numpy' : ('https://numpy.org/doc/stable/', None),
69+
'python' : ('https://docs.python.org/{.major}'.format(sys.version_info), None),
70+
'matplotlib': ('https://matplotlib.org/stable/', None),
71+
'mayavi' : ('http://docs.enthought.com/mayavi/mayavi', None),
72+
'sklearn' : ('https://scikit-learn.org/stable', None),
73+
'skimage' : ('https://scikit-image.org/docs/dev/', None),
74+
'pyvista' : ('https://docs.pyvista.org/', None),
75+
'sphinx' : ('https://www.sphinx-doc.org/en/master/', None),
76+
'pandas' : ('https://pandas.pydata.org/pandas-docs/stable/', None),
7777
}
7878

7979
napoleon_google_docstring = True
8080

8181
autodoc_default_options = {
82-
'autodoc_default_flags': ['members'],
83-
'members' : None,
84-
'member-order' : 'bysource',
85-
'special-members' : '__init__',
86-
'undoc-members' : True,
87-
'exclude-members' : '__weakref__'
82+
'autodoc_default_flags': ['members'],
83+
'members' : None,
84+
'member-order' : 'bysource',
85+
'special-members' : '__init__',
86+
'undoc-members' : True,
87+
'exclude-members' : '__weakref__'
8888
}
8989
autosummary_generate = True
9090
autosummary_imported_members = True
@@ -108,8 +108,8 @@
108108

109109
with open(os.path.join(os.path.dirname(__file__), '../../AUTHORS.rst'), 'r') as f:
110110
author = f.read()
111-
112-
version = gempy.__version__ # The short X.Y version.
111+
112+
version = gempy.__version__
113113
release = gempy.__version__ # The full version, including alpha/beta/rc tags.
114114
today_fmt = '%d %B %Y'
115115
language = 'en'
@@ -120,7 +120,7 @@
120120
# List of patterns, relative to source directory, that match files and
121121
# directories to ignore when looking for source files.
122122
# This patterns also effect to html_static_path and html_extra_path
123-
exclude_patterns = ['_build', '**.ipynb_checkpoints', 'Thumbs.db', '.DS_Store', 'errors.txt', '../test' ]
123+
exclude_patterns = ['_build', '**.ipynb_checkpoints', 'Thumbs.db', '.DS_Store', 'errors.txt', '../test']
124124

125125
# The name of the Pygments (syntax highlighting) style to use.
126126
pygments_style = 'sphinx'
@@ -133,32 +133,32 @@
133133

134134
# * -- Sphinx Gallery Options
135135
sphinx_gallery_conf = {
136-
# path to your examples scripts
137-
"examples_dirs" : [
138-
"../../examples/tutorials",
139-
"../../examples/examples",
140-
# "../../examples/integrations",
141-
],
142-
# path where to save gallery generated examples
143-
"gallery_dirs" : [
144-
'tutorials',
145-
"examples",
146-
# 'integrations'
147-
],
148-
"filename_pattern": r"\.py",
149-
"download_all_examples" : False, # Remove the "Download all examples" button from the top level gallery
150-
"within_subsection_order": FileNameSortKey, # Sort gallery example by file name instead of number of lines (default)
151-
"backreferences_dir" : 'gen_modules/backreferences', # directory where function granular galleries are stored
152-
"doc_module" : ("gempy", "gempy_viewer", 'numpy', 'pandas', 'matplotlib'), # Modules for which function level galleries are created. In
153-
"image_scrapers" : ('pyvista', 'matplotlib'),
154-
'first_notebook_cell' : ("%matplotlib inline\n"
155-
"from pyvista import set_plot_theme\n"
156-
"set_plot_theme('document')"),
157-
'reference_url' : {
158-
'gempy': None, # The module you locally document uses None
159-
'numpy': 'https://numpy.org/doc/stable/'
160-
161-
},
136+
# path to your examples scripts
137+
"examples_dirs" : [
138+
"../../examples/tutorials",
139+
"../../examples/examples",
140+
# "../../examples/integrations",
141+
],
142+
# path where to save gallery generated examples
143+
"gallery_dirs" : [
144+
'tutorials',
145+
"examples",
146+
# 'integrations'
147+
],
148+
"filename_pattern" : r"\.py",
149+
"download_all_examples" : False, # Remove the "Download all examples" button from the top level gallery
150+
"within_subsection_order": FileNameSortKey, # Sort gallery example by file name instead of number of lines (default)
151+
"backreferences_dir" : 'gen_modules/backreferences', # directory where function granular galleries are stored
152+
"doc_module" : ("gempy", "gempy_viewer", 'numpy', 'pandas', 'matplotlib'), # Modules for which function level galleries are created. In
153+
"image_scrapers" : ('pyvista', 'matplotlib'),
154+
'first_notebook_cell' : ("%matplotlib inline\n"
155+
"from pyvista import set_plot_theme\n"
156+
"set_plot_theme('document')"),
157+
'reference_url' : {
158+
'gempy': None, # The module you locally document uses None
159+
'numpy': 'https://numpy.org/doc/stable/'
160+
161+
},
162162
}
163163

164164
# endregion
@@ -171,16 +171,16 @@
171171

172172
html_theme = 'alabaster'
173173
html_theme_options = {
174-
'github_user' : 'gempy-project',
175-
'github_repo' : 'gempy',
176-
'github_type' : 'star',
177-
'logo' : 'logos/gempy.png',
178-
'logo_name' : False,
179-
'travis_button' : False,
180-
'page_width' : '1200px',
181-
'fixed_sidebar' : False,
182-
'show_related' : True,
183-
'sidebar_collapse': True,
174+
'github_user' : 'gempy-project',
175+
'github_repo' : 'gempy',
176+
'github_type' : 'star',
177+
'logo' : 'logos/gempy.png',
178+
'logo_name' : False,
179+
'travis_button' : False,
180+
'page_width' : '1200px',
181+
'fixed_sidebar' : False,
182+
'show_related' : True,
183+
'sidebar_collapse': True,
184184
}
185185

186186
# Custom sidebar templates, maps document names to template names.

‎gempy/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# * Assert at least pyton 3.10
1919
assert sys.version_info[0] >= 3 and sys.version_info[1] >= 10, "GemPy requires Python 3.10 or higher"
2020

21-
__version__ = '2023.2.0b1'
21+
from ._version import __version__
2222

2323
if __name__ == '__main__':
2424
pass

0 commit comments

Comments
 (0)