Skip to content

Commit 7847839

Browse files
committed
switch to the pydata sphinx theme
1 parent de5b043 commit 7847839

28 files changed

+66
-27
lines changed

docs/main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
@app.route("/")
2222
async def forward_to_index(request):
23-
return response.redirect("/docs/index.html")
23+
return response.redirect("/docs/content/index.html")
2424

2525

2626
mount, element = multiview()

docs/source/conf.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
source_suffix = ".rst"
6565

6666
# The master toctree document.
67-
master_doc = "index"
67+
master_doc = "content/index"
6868

6969
# The language for content autogenerated by Sphinx. Refer to documentation
7070
# for a list of supported languages.
@@ -95,7 +95,7 @@
9595
# The theme to use for HTML and HTML Help pages. See the documentation for
9696
# a list of builtin themes.
9797
#
98-
html_theme = "sphinx_rtd_theme"
98+
html_theme = "pydata_sphinx_theme"
9999

100100
# Theme options are theme-specific and customize the look and feel of a theme
101101
# further. For a list of options available for each theme, see the
@@ -110,7 +110,11 @@
110110

111111
# These paths are either relative to html_static_path
112112
# or fully qualified paths (eg. https://...)
113-
html_css_files = ["css/interactive-widget.css"]
113+
html_css_files = [
114+
"css/interactive-widget.css",
115+
"css/custom-max-width.css",
116+
"css/fix-code-linenos.css",
117+
]
114118

115119
# Custom sidebar templates, must be a dictionary that maps document names
116120
# to template names.
File renamed without changes.
File renamed without changes.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Advanced Usage
2+
==============
3+
4+
Explains the high level abstractions of IDOM like layouts, distpatchers and servers as
5+
well as more advanced features that allow you to import existing or custom javascript
6+
into your IDOM views. If you're just getting started check out the :ref:`User Guide`
7+
first before you dive in here.
8+
9+
.. toctree::
10+
:maxdepth: 1
11+
12+
core-concepts
13+
javascript-modules
14+
extra-features

docs/source/javascript-modules.rst renamed to docs/source/content/advanced-usage/javascript-modules.rst

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,8 @@ hook in a module of your own making on the fly. As before, we'll be using a
7777
parameter which is a file-like object. In the following example we'll use Victory again,
7878
but this time we'll add a callback to it. Unfortunately we can't just pass it in
7979
:ref:`like we did before <Passing Props To Components>` because Victory's event API
80-
is a bit more complex so we've implemented a quick wrapper for it in a file ``chart.js``.
81-
82-
.. literalinclude:: examples/custom_chart.js
83-
:language: javascript
84-
85-
Which we can read in as a ``source`` to :class:`~idom.widgets.utils.Module`:
80+
is a bit more complex so we've implemented a quick wrapper for it in a file ``chart.js``
81+
which we can read in as a ``source`` to :class:`~idom.widgets.utils.Module`:
8682

8783
Click the bars to trigger an event 👇
8884

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
API Reference
2+
=============
3+
4+
Detailed explanations of classes, functions, and protocols used by IDOM.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
package-api
10+
specifications
File renamed without changes.

docs/source/api.rst renamed to docs/source/content/api-reference/package-api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
API
2-
===
1+
Package API
2+
===========
33

44
.. contents::
55
:local:
File renamed without changes.

0 commit comments

Comments
 (0)