Skip to content

Commit 3716bda

Browse files
committed
update docs structure
- pydata sphinx theme - enable myst for new docs - update rtd config - subdirectories for tutorial, reference - fix some links - remove stale, long-skipped winhpc doc
1 parent c453f9a commit 3716bda

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+82
-406
lines changed

docs/environment.yml

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
myst-parser
2+
pydata-sphinx-theme
3+
sphinx
4+
sphinx-copybutton

docs/source/api/ipyparallel.rst

Lines changed: 2 additions & 2 deletions

docs/source/changelog.rst

Lines changed: 3 additions & 1 deletion

docs/source/conf.py

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
'sphinx.ext.inheritance_diagram',
5050
'sphinx.ext.intersphinx',
5151
'sphinx.ext.napoleon',
52+
'myst_parser',
5253
'IPython.sphinxext.ipython_console_highlighting',
5354
]
5455

@@ -57,8 +58,7 @@
5758

5859
# The suffix(es) of source filenames.
5960
# You can specify multiple suffix as a list of string:
60-
# source_suffix = ['.rst', '.md']
61-
source_suffix = '.rst'
61+
source_suffix = ['.rst', '.md']
6262

6363
# Add dev disclaimer.
6464
if iprelease['version_info'][-1] == 'dev':
@@ -144,12 +144,27 @@
144144

145145
# The theme to use for HTML and HTML Help pages. See the documentation for
146146
# a list of builtin themes.
147-
# html_theme = 'alabaster'
147+
html_theme = 'pydata_sphinx_theme'
148+
148149

149150
# Theme options are theme-specific and customize the look and feel of a theme
150151
# further. For a list of options available for each theme, see the
151152
# documentation.
152-
# html_theme_options = {}
153+
# https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/configuring.html
154+
html_theme_options = {
155+
# "navbar_center": [], # disable navbar-nav because it's way too big right now
156+
"icon_links": [
157+
{
158+
"name": "GitHub",
159+
"url": "https://github.com/ipyparallel",
160+
"icon": "fab fa-github-square",
161+
},
162+
],
163+
}
164+
165+
html_context = {
166+
"github_url": "https://github.com/ipython/ipyparallel",
167+
}
153168

154169
# Add any paths that contain custom themes here, relative to this directory.
155170
# html_theme_path = []
@@ -262,14 +277,6 @@
262277
u'The IPython Development Team',
263278
'manual',
264279
),
265-
(
266-
'parallel/winhpc_index',
267-
'winhpc_whitepaper.tex',
268-
u'Using IPython on Windows HPC Server 2008',
269-
u"Brian E. Granger",
270-
'manual',
271-
True,
272-
),
273280
]
274281

275282
# The name of an image file (relative to this directory) to place at the top of

docs/source/figs/hpc_job_manager.pdf

-78.9 KB
Binary file not shown.

docs/source/figs/hpc_job_manager.png

-81.2 KB
Binary file not shown.

docs/source/index.rst

Lines changed: 6 additions & 15 deletions

docs/source/dag_dependencies.rst renamed to docs/source/reference/dag_dependencies.rst

Lines changed: 2 additions & 2 deletions

0 commit comments

Comments
 (0)