From 9b02e03c2a6f8a74a83dd40c69719fe36f4dd154 Mon Sep 17 00:00:00 2001
From: Felix Morgner <felix.morgner@gmail.com>
Date: Sat, 24 Dec 2016 12:46:04 +0100
Subject: Update documentation

---
 doc/Makefile         | 20 ++++++++++++++++++++
 doc/requirements.txt | 13 +++++++++++++
 doc/src/api.rst      |  7 +++++++
 doc/src/conf.py      | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 doc/src/extfs.rst    |  5 +++++
 doc/src/index.rst    | 15 +++++++++++++++
 6 files changed, 109 insertions(+)
 create mode 100644 doc/Makefile
 create mode 100644 doc/requirements.txt
 create mode 100644 doc/src/api.rst
 create mode 100644 doc/src/conf.py
 create mode 100644 doc/src/extfs.rst
 create mode 100644 doc/src/index.rst

(limited to 'doc')

diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..69a0496
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = extfs
+SOURCEDIR     = src
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..5b391f4
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,13 @@
+alabaster==0.7.9
+Babel==2.3.4
+breathe==4.4.0
+docutils==0.13.1
+imagesize==0.7.1
+Jinja2==2.8
+MarkupSafe==0.23
+Pygments==2.1.3
+pytz==2016.10
+six==1.10.0
+snowballstemmer==1.2.1
+Sphinx==1.4.9
+sphinx-rtd-theme==0.1.9
diff --git a/doc/src/api.rst b/doc/src/api.rst
new file mode 100644
index 0000000..3b2cec2
--- /dev/null
+++ b/doc/src/api.rst
@@ -0,0 +1,7 @@
+The API
+=======
+
+.. toctree::
+  :maxdepth: 1
+
+  extfs
diff --git a/doc/src/conf.py b/doc/src/conf.py
new file mode 100644
index 0000000..a67aee4
--- /dev/null
+++ b/doc/src/conf.py
@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+import subprocess
+
+subprocess.call('cd ../../ && doxygen', shell=True)
+
+html_theme = 'sphinx_rtd_theme'
+
+extensions = ['breathe']
+
+breathe_projects = {'extfs': os.path.abspath('../../build/xml') }
+breathe_default_project = 'extfs'
+
+source_suffix = '.rst'
+master_doc = 'index'
+
+project = 'extfs'
+copyright = '2016, Felix Morgner'
+author = 'Felix Morgner'
+
+version = '1.0.0'
+release = '1.0.0'
+
+language = 'en'
+
+exclude_patterns = [
+    'build',
+    'Thumbs.db',
+    '.DS_Store',
+    'ext/breathe',
+]
+
+pygments_style = 'sphinx'
+
+todo_include_todos = False
+
+htmlhelp_basename = 'extfsdoc'
+
+man_pages = [
+    (master_doc, 'extfs', 'extfs Documentation',
+     [author], 1)
+]
+
+rst_epilog = '.. |project_name| replace:: **%s**' % project
+
+primary_domain = 'cpp'
diff --git a/doc/src/extfs.rst b/doc/src/extfs.rst
new file mode 100644
index 0000000..d8f1f5a
--- /dev/null
+++ b/doc/src/extfs.rst
@@ -0,0 +1,5 @@
+File System Access
+==================
+
+.. doxygenstruct:: fs::extfs
+  :members:
diff --git a/doc/src/index.rst b/doc/src/index.rst
new file mode 100644
index 0000000..dee63dd
--- /dev/null
+++ b/doc/src/index.rst
@@ -0,0 +1,15 @@
+Welcome to extfs's documentation!
+=================================
+
+|project_name| is a simple, pure C++ implementation of the ext* family of file
+systems. It provides a simple API to inspect, traverse and modify ext2/3/4
+file systems. |project_name| is designed to be included directly in the build
+process of other projects, that why no binary builds are provided.
+
+User documentation
+------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   api
-- 
cgit v1.2.3