[librsvg: 2/21] Start a Sphinx skeleton for the developer's documentation




commit 9484ec4b327e7ae33c3d29a99cdf6f10b89bf861
Author: Federico Mena Quintero <federico gnome org>
Date:   Tue Jun 14 11:22:02 2022 -0500

    Start a Sphinx skeleton for the developer's documentation
    
    Part-of: <https://gitlab.gnome.org/GNOME/librsvg/-/merge_requests/729>

 .gitignore           |  2 --
 devel-docs/Makefile  | 20 ++++++++++++++++++++
 devel-docs/conf.py   | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 devel-docs/index.rst | 27 +++++++++++++++++++++++++++
 4 files changed, 99 insertions(+), 2 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index fcdd8e618..e1c8dc461 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,5 @@
 *~
 ChangeLog
-Makefile
-Makefile.in
 TAGS
 aclocal.m4
 autom4te.cache
diff --git a/devel-docs/Makefile b/devel-docs/Makefile
new file mode 100644
index 000000000..d4bb2cbb9
--- /dev/null
+++ b/devel-docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+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/devel-docs/conf.py b/devel-docs/conf.py
new file mode 100644
index 000000000..657444cce
--- /dev/null
+++ b/devel-docs/conf.py
@@ -0,0 +1,52 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'librsvg'
+copyright = '2022, Federico Mena Quintero'
+author = 'Federico Mena Quintero'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# 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']
\ No newline at end of file
diff --git a/devel-docs/index.rst b/devel-docs/index.rst
new file mode 100644
index 000000000..e22ea6800
--- /dev/null
+++ b/devel-docs/index.rst
@@ -0,0 +1,27 @@
+Development documentation for librsvg
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Welcome to the developer's manual for librsvg.  This is for people who
+want to work on librsvg's development, nor for users of the library or
+the `rsvg-convert` program.
+
+Before embarking on big changes to librsvg, please write a little
+design document modeled on the following ones, and submit a merge
+request.  We can then discuss it before coding.  This way we will have
+a sort of big-picture development history apart from commit messages.
+
+Design documents
+================
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]