Skip to content

Commit 9d22767

Browse files
committed
Make doc structure more user friendly
1 parent bd8ec45 commit 9d22767

File tree

4 files changed

+53
-42
lines changed

4 files changed

+53
-42
lines changed

docs/source/conf.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343

4444
master_doc = 'index'
4545
project = 'Jupyter Widgets'
46-
copyright = '2017 Project Jupyter'
46+
copyright = '2017-2021 Project Jupyter'
4747
author = 'Jupyter Team'
4848

4949
language = None
@@ -103,4 +103,11 @@
103103
# -- Theme options -----------------
104104

105105
# Options are theme-specific and customize the look and feel of the theme.
106-
html_theme_options = {}
106+
html_theme_options = {
107+
# Toc options
108+
'collapse_navigation': True,
109+
'sticky_navigation': True,
110+
'navigation_depth': 2,
111+
'includehidden': True,
112+
'titles_only': False
113+
}

docs/source/developer_docs.rst

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Developer Docs
2-
===============
1+
ipywidgets Development
2+
======================
33

44
The Jupyter widgets packages are developed in the `https://github.com/jupyter-widgets/ipywidgets <https://github.com/jupyter-widgets/ipywidgets>`_ git repository. See the issue tracker, README, and other Github documents for the most recent information.
55

@@ -13,15 +13,3 @@ Scope of ipywidgets
1313
2. A basic, lightweight set of form controls that *use* this framework, based on standard HTML form controls. These included controls include a text area, text box, select and multiselect controls, checkbox, etc. A few more advanced controls that are very popular are also included, such as a slider and basic tab panels.
1414

1515
The framework for building rich interactive objects is the foremost purpose of the ipywidgets project, and the set of included reference form controls is purposefully kept small and self-contained to serve as something like a reference implementation. We encourage and support a robust ecosystem of packages built on top of the ipywidgets framework to provide more complicated interactive objects, such as maps or 2d and 3d visualizations, or other form control systems built on a variety of popular Javascript frameworks such as Material or Vue.
16-
17-
18-
Additional Developer Docs
19-
-------------------------
20-
21-
.. toctree::
22-
:maxdepth: 3
23-
24-
dev_install.md
25-
dev_testing.md
26-
dev_docs
27-
dev_release.md

docs/source/index.rst

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,48 @@
11
ipywidgets
22
==========
33

4-
Full Table of Contents
5-
----------------------
4+
.. only:: html
5+
6+
:Release: |version|
7+
:Date: |today|
68

79
.. toctree::
8-
:maxdepth: 2
10+
:caption: User Guide
11+
:maxdepth: 1
12+
13+
user_install.md
14+
examples/Widget Basics.ipynb
15+
examples/Widget List.ipynb
16+
examples/Output Widget.ipynb
17+
examples/Widget Events.ipynb
18+
examples/Widget Styling.ipynb
19+
examples/Layout Templates.ipynb
20+
examples/Widget Custom.ipynb
21+
examples/Using Interact.ipynb
22+
examples/Widget Low Level.ipynb
23+
examples/Widget Asynchronous.ipynb
24+
embedding.md
25+
26+
.. toctree::
27+
:caption: Changelog and Migration
28+
:maxdepth: 1
29+
30+
changelog.md
31+
migration_guides.md
32+
33+
.. toctree::
34+
:caption: Developer Guide
35+
:maxdepth: 1
36+
37+
developer_docs
38+
dev_install.md
39+
dev_testing.md
40+
dev_docs
41+
contributing.md
42+
dev_release.md
43+
44+
.. only:: html
945

10-
user_guide
11-
developer_docs
46+
* :ref:`genindex`
47+
* :ref:`modindex`
48+
* :ref:`search`

docs/source/user_guide.rst

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

0 commit comments

Comments
 (0)