summaryrefslogtreecommitdiff
path: root/source
diff options
context:
space:
mode:
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2023-06-14 19:00:51 +0200
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2023-06-14 19:00:51 +0200
commita472a8e904a326cc6460a4b0abb6b4d567e3cd17 (patch)
treeb99e3520098ce9cdf9cf6371d1323b21fa980609 /source
Project structure
Diffstat (limited to 'source')
-rw-r--r--source/bibliography/index.rst9
-rw-r--r--source/bibliography/misc.bib0
-rw-r--r--source/conf.py60
-rw-r--r--source/index.rst79
4 files changed, 148 insertions, 0 deletions
diff --git a/source/bibliography/index.rst b/source/bibliography/index.rst
new file mode 100644
index 0000000..b5317b2
--- /dev/null
+++ b/source/bibliography/index.rst
@@ -0,0 +1,9 @@
+##############
+ Bibliography
+##############
+
+Miscellaneous
+=============
+
+.. bibliography:: misc.bib
+ :all:
diff --git a/source/bibliography/misc.bib b/source/bibliography/misc.bib
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/source/bibliography/misc.bib
diff --git a/source/conf.py b/source/conf.py
new file mode 100644
index 0000000..2a940ae
--- /dev/null
+++ b/source/conf.py
@@ -0,0 +1,60 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Valhalla’s Docs'
+copyright = '2023, Elena Grandi'
+author = 'Elena “of Valhalla”'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+ 'sphinxcontrib.inkscapeconverter',
+ 'sphinxcontrib.bibtex',
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']
+
+# -- Options for latex output -------------------------------------------------
+
+latex_engine = 'xelatex'
+latex_show_urls = 'footnote'
+latex_toplevel_sectioning = 'part'
+
+latex_elements = {
+ 'papersize': 'a5paper',
+ 'fontpkg': r'''
+ \setmainfont{Gentium}
+ \setsansfont{Gentium}
+ \setmonofont{FreeMono}[Scale=0.8]
+ ''',
+ 'sphinxsetup': r'''
+ TitleColor={named}{black},
+ InnerLinkColor={named}{gray},
+ OuterLinkColor={named}{gray},
+ hmargin={2cm,2cm},
+ vmargin={2.5cm,2.5cm},
+ ''',
+ 'fncychap': r'\usepackage[Rejne]{fncychap}',
+ }
+
+# Options for extensions
+
+bibtex_bibfiles = [
+ "bibliography/misc.bib",
+]
+
diff --git a/source/index.rst b/source/index.rst
new file mode 100644
index 0000000..9f748d5
--- /dev/null
+++ b/source/index.rst
@@ -0,0 +1,79 @@
+.. Valhalla’s Docs documentation master file, created by
+ sphinx-quickstart on Wed Jun 14 17:28:02 2023.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Valhalla’s Docs
+==========================
+
+This is a collection of HOWTOs and computer related documents and
+articles written by Elena “of Valhalla”.
+
+The latest version of this document is published on
+https://docs.trueelena.org/; a `pdf version
+<https://docs.trueelena.org/Valhallasdocs.pdf>`_ and an `epub version
+<https://docs.trueelena.org/Valhallasdocs.epub>`_
+
+The PDF and epub versions also don't include any download file which can
+be downloaded from the individual pages of this webiste, or as the `full
+website source zip archive
+<https://docs.trueelena.org/Valhallasdocs.zip>`_ or `website source
+tarball <https://docs.trueelena.org/Valhallasdocs.tar.xz>`_.
+
+This document is generated with Sphinx_, and its sources are published
+on https://git.trueelena.org/pages/docs/.
+
+.. _Sphinx: https://www.sphinx-doc.org
+
+Generating an rss of new pages with Sphinx doesn't seem to be (easily)
+possible, but when new patterns are added or existing patterns receive
+significant changes they are usually announced on `my blog`_, which of
+course has an rss.
+
+.. _`my blog`: https://blog.trueelena.org
+
+.. raw:: html
+
+ <p>
+ If you have questions or comments about anything on this site you
+ can contact me via email at patterns AT trueelena.org, or you can find
+ me on the fediverse
+ <a href="https://social.gl-como.it/profile/valhalla/" rel=me>
+ @valhalla@social.gl.como.it
+ </a>
+ </p>
+
+.. only:: not html
+
+ If you have questions or comments about anything on this site you
+ can contact me via email at patterns AT trueelena.org, or you can find
+ me on the fediverse as `@valhalla@social.gl.como.it
+ <https://social.gl-como.it/profile/valhalla/>`_.
+
+------
+
+Copyright 2023 Elena Grandi
+
+This work is licensed under the Creative Commons Attribution-ShareAlike
+4.0 International License. To view a copy of this license, visit
+http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
+Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+
+-----
+
+.. toctree::
+ :maxdepth: 3
+ :caption: Contents:
+
+ bibliography/index
+
+.. only:: draft
+
+ * :ref:`genindex`
+
+.. only:: html
+
+ * :ref:`search`
+
+
+