summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/api.rst7
-rw-r--r--doc/src/conf.py49
-rw-r--r--doc/src/extfs.rst5
-rw-r--r--doc/src/index.rst15
4 files changed, 76 insertions, 0 deletions
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