aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2020-08-12 21:06:20 +0200
committerLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2020-08-12 21:06:20 +0200
commit49f7e13a7ac9a582d11e9c1ad01e71740f486601 (patch)
tree03dab4461906a22614e8e0a6da49fa46ca3f3b95
parentfc064f991e3936dff22a986c5eec10484e27fa53 (diff)
parentf412da2fb52eab937e2f2a963848f1d8a5ec5972 (diff)
downloadsparse-49f7e13a7ac9a582d11e9c1ad01e71740f486601.tar.gz
Merge branch 'doc-next'
* doc: more compact sidebar * doc: use shorter titles * doc: reorganize the table of content
-rw-r--r--Documentation/IR.rst4
-rw-r--r--Documentation/conf.py8
-rw-r--r--Documentation/dev-options.rst4
-rw-r--r--Documentation/doc-guide.rst4
-rw-r--r--Documentation/index.rst26
-rw-r--r--Documentation/sphinx/static/theme_overrides.css20
-rw-r--r--Documentation/types.rst6
7 files changed, 51 insertions, 21 deletions
diff --git a/Documentation/IR.rst b/Documentation/IR.rst
index 33a76166..97d4b2b2 100644
--- a/Documentation/IR.rst
+++ b/Documentation/IR.rst
@@ -1,7 +1,7 @@
.. default-domain:: ir
-Sparse's Intermediate Representation
-====================================
+Intermediate Representation
+===========================
Instructions
~~~~~~~~~~~~
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 89ba3d78..affa9073 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -113,7 +113,13 @@ except:
# 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".
-# html_static_path = ['sphinx/static']
+html_static_path = ['sphinx/static']
+
+html_context = {
+ 'css_files': [
+ '_static/theme_overrides.css',
+ ],
+}
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
diff --git a/Documentation/dev-options.rst b/Documentation/dev-options.rst
index 23e8096c..57f9e8d6 100644
--- a/Documentation/dev-options.rst
+++ b/Documentation/dev-options.rst
@@ -1,5 +1,5 @@
-sparse - extra options for developers
-=====================================
+Extra options for developers
+============================
SYNOPSIS
--------
diff --git a/Documentation/doc-guide.rst b/Documentation/doc-guide.rst
index 8133cb3a..29f39aab 100644
--- a/Documentation/doc-guide.rst
+++ b/Documentation/doc-guide.rst
@@ -1,5 +1,5 @@
-How to write sparse documentation
-=================================
+Documentation guide
+===================
Introduction
------------
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 4047343a..e29a5643 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -25,9 +25,6 @@ by Christopher Li in 2009 and by Luc Van Oostenryck in late 2018.
Getting Sparse
--------------
-You can find tarballs of released versions of Sparse at
-https://www.kernel.org/pub/software/devel/sparse/dist/.
-
The most recent version can be obtained directly from the Git
repository with the command::
@@ -35,6 +32,8 @@ repository with the command::
You can also `browse the Git repository <https://git.kernel.org/pub/scm/devel/sparse/sparse.git>`_
or use the mirror at https://github.com/lucvoo/sparse.
+The tarballs of released versions of Sparse and their signatures can be found at
+https://www.kernel.org/pub/software/devel/sparse/dist/.
Once you have the sources, to build Sparse and install it in your ~/bin
directory, just do::
@@ -65,22 +64,27 @@ Bugs can also be reported and tracked via the `Linux kernel's bugzilla for spars
.. toctree::
- :caption: Documentation
+ :caption: User Documentation
:maxdepth: 1
annotations
- dev-options
- types
- api
- IR
- test-suite
- doc-guide
+
+Some interesting external documentation:
+
+* `Sparse: a look under the hood <https://lwn.net/Articles/689907/>`_
+* `Sparse: a short overview <https://sil2.osadl.org/events/ewc-2019-hands-on/sparse_slides.pdf>`_
.. toctree::
- :caption: How to contribute
+ :caption: Development
:maxdepth: 1
submitting-patches
+ types
+ api
+ dev-options
+ IR
+ test-suite
+ doc-guide
TODO
.. toctree::
diff --git a/Documentation/sphinx/static/theme_overrides.css b/Documentation/sphinx/static/theme_overrides.css
new file mode 100644
index 00000000..3e4bc3b0
--- /dev/null
+++ b/Documentation/sphinx/static/theme_overrides.css
@@ -0,0 +1,20 @@
+p {
+ margin-bottom: 0.6em;
+}
+
+ul.simple {
+ margin-top: -0.5em;
+ margin-bottom: 0.5em;
+}
+
+.rst-content .toctree-wrapper ul {
+ margin-bottom: 0.5em;
+}
+
+.wy-menu-vertical a, .wy-menu-vertical li.current > a, .wy-menu-vertical p.caption {
+ padding: 0.2em 1.2em;
+}
+
+.wy-side-nav-search > a img.logo {
+ width: 60%;
+}
diff --git a/Documentation/types.rst b/Documentation/types.rst
index 272f32a0..974f9861 100644
--- a/Documentation/types.rst
+++ b/Documentation/types.rst
@@ -1,6 +1,6 @@
-********************
-Sparse's Type System
-********************
+***********
+Type System
+***********
struct symbol is used to represent symbols & types but
most parts pertaining to the types are in the field 'ctype'.