summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py20
-rw-r--r--doc/contributing.rst2
-rw-r--r--doc/man_index.rst9
-rw-r--r--doc/synopsis.rst4
4 files changed, 17 insertions, 18 deletions
diff --git a/doc/conf.py b/doc/conf.py
index e3f0e02..c607fc5 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -52,7 +52,6 @@ templates_path = ['_templates']
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
-# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
@@ -87,7 +86,7 @@ html_theme = 'sphinx_rtd_theme'
# 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 = ['_static']
+#html_static_path = ['_static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
@@ -131,7 +130,7 @@ latex_elements = {
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'biboumi.tex', 'biboumi Documentation',
- 'Florent Le Coz', 'manual'),
+ author, 'manual'),
]
@@ -140,21 +139,8 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- (master_doc, 'biboumi', 'biboumi Documentation',
+ ('man_index', 'biboumi', 'biboumi Documentation',
[author], 1)
]
-
-# -- Options for Texinfo output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (master_doc, 'biboumi', 'biboumi Documentation',
- author, 'biboumi', 'One line description of project.',
- 'Miscellaneous'),
-]
-
-
# -- Extension configuration -------------------------------------------------
diff --git a/doc/contributing.rst b/doc/contributing.rst
index ee499fc..26572fa 100644
--- a/doc/contributing.rst
+++ b/doc/contributing.rst
@@ -91,7 +91,7 @@ Please try to follow the existing style:
- Use only spaces, not tabs.
- Curly brackets are on their own lines.
- Use this-> everywhere it’s possible.
-- Don’t start class attributes with “m_” or similar.
+- Don’t start class attributes with “m\_” or similar.
- Type names are in PascalCase.
- Everything else is in snake_case.
diff --git a/doc/man_index.rst b/doc/man_index.rst
new file mode 100644
index 0000000..3de981d
--- /dev/null
+++ b/doc/man_index.rst
@@ -0,0 +1,9 @@
+Biboumi's man page index
+========================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ synopsis
+ admin
diff --git a/doc/synopsis.rst b/doc/synopsis.rst
new file mode 100644
index 0000000..5b93a92
--- /dev/null
+++ b/doc/synopsis.rst
@@ -0,0 +1,4 @@
+Synopsis
+========
+
+biboumi [*config_filename*]