Skip to content

Commit a928672

Browse files
emillonemillon
authored
doc: use a hierarchy of index pages (#9737)
* doc: use index Signed-off-by: Etienne Millon <[email protected]> * maxdepth Signed-off-by: Etienne Millon <[email protected]> * Short descriptions in index.rst Signed-off-by: Etienne Millon <[email protected]> * Reference guides -> reference manual Signed-off-by: Etienne Millon <[email protected]> --------- Signed-off-by: Etienne Millon <[email protected]>
1 parent 1af5b74 commit a928672

File tree

7 files changed

+112
-87
lines changed

7 files changed

+112
-87
lines changed

‎doc/advanced/index.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Advanced Topics
2+
===============
3+
4+
These documents describe some advanced or very specific features of Dune.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
findlib-dynamic
10+
profiling-dune
11+
package-version
12+
ocaml-syntax
13+
variables-artifacts
14+
custom-cmxs

‎doc/explanation/index.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Explanation
2+
===========
3+
4+
These documents explain how certain feature works, or how Dune integrates with
5+
the rest of the OCaml ecosystem.
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
preprocessing
11+
ocaml-ecosystem
12+
opam-integration

‎doc/getting-started/index.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Getting Started and Core Concepts
2+
=================================
3+
4+
These documents should be the first ones read by new Dune users. They explain
5+
what Dune is, how it works, and how to use it.
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
../overview
11+
../quick-start
12+
../dune-files
13+
../usage

‎doc/howto/index.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
How-to Guides
2+
=============
3+
4+
These guides will help you use Dune's features in your project.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
formatting
10+
opam-file-generation
11+
../cross-compilation
12+
../foreign-code
13+
../documentation
14+
../sites
15+
../instrumentation
16+
../jsoo
17+
../melange
18+
../toplevel-integration
19+
../variants
20+
../tests
21+
bundle

‎doc/index.rst‎

Lines changed: 7 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,12 @@
1-
.. dune documentation master file, created by
2-
sphinx-quickstart on Tue Apr 11 21:24:42 2017.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
5-
61
Welcome to Dune's Documentation!
72
================================
83

9-
.. We include the titles of the pages here to make sure they are in
10-
alphabetical order. Eventually we should name the files and titles
11-
similarly.
12-
13-
.. toctree::
14-
:caption: Getting Started and Core Concepts
15-
:maxdepth: 3
16-
17-
overview
18-
quick-start
19-
dune-files
20-
usage
21-
22-
.. toctree::
23-
:caption: How-to Guides
24-
25-
howto/formatting
26-
howto/opam-file-generation
27-
cross-compilation
28-
foreign-code
29-
documentation
30-
sites
31-
instrumentation
32-
jsoo
33-
melange
34-
toplevel-integration
35-
variants
36-
tests
37-
howto/bundle
38-
39-
.. toctree::
40-
:caption: Reference Guides
41-
:maxdepth: 3
42-
43-
reference/lexical-conventions
44-
reference/ordered-set-language
45-
reference/boolean-language
46-
reference/predicate-language
47-
reference/library-dependencies
48-
reference/actions
49-
reference/foreign
50-
reference/cli
51-
reference/preprocessing-spec
52-
reference/packages
53-
reference/findlib
54-
reference/aliases
55-
reference/cram
56-
concepts/scopes
57-
concepts/variables
58-
concepts/dependency-spec
59-
concepts/ocaml-flags
60-
concepts/sandboxing
61-
concepts/locks
62-
concepts/promotion
63-
concepts/package-spec
64-
coq
65-
caching
66-
dune-libs
67-
rpc
68-
69-
.. toctree::
70-
:caption: Explanations
71-
72-
explanation/preprocessing
73-
explanation/ocaml-ecosystem
74-
explanation/opam-integration
75-
76-
.. toctree::
77-
:caption: Advanced topics
78-
79-
advanced/findlib-dynamic
80-
advanced/profiling-dune
81-
advanced/package-version
82-
advanced/ocaml-syntax
83-
advanced/variables-artifacts
84-
advanced/custom-cmxs
85-
864
.. toctree::
87-
:caption: Miscellaneous
88-
:maxdepth: 3
5+
:maxdepth: 2
896

90-
faq
91-
goals
92-
hacking
7+
getting-started/index
8+
howto/index
9+
reference/index
10+
explanation/index
11+
advanced/index
12+
misc/index

‎doc/misc/index.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Miscellaneous
2+
=============
3+
4+
These documents contain tidbits of info that do not fit anywhere else, and
5+
information about the project itself.
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
../faq
11+
../goals
12+
../hacking

‎doc/reference/index.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Reference Manual
2+
================
3+
4+
These documents specify the various features and languages present in Dune.
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
lexical-conventions
10+
ordered-set-language
11+
boolean-language
12+
predicate-language
13+
library-dependencies
14+
actions
15+
foreign
16+
cli
17+
preprocessing-spec
18+
packages
19+
findlib
20+
aliases
21+
cram
22+
../concepts/scopes
23+
../concepts/variables
24+
../concepts/dependency-spec
25+
../concepts/ocaml-flags
26+
../concepts/sandboxing
27+
../concepts/locks
28+
../concepts/promotion
29+
../concepts/package-spec
30+
../coq
31+
../caching
32+
../dune-libs
33+
../rpc

0 commit comments

Comments
 (0)