From: Ian Jackson Date: Thu, 5 Aug 2021 10:26:47 +0000 (+0100) Subject: Makefile and docs framework X-Git-Tag: hippotat/1.0.0~319 X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ian/git?a=commitdiff_plain;h=5c76bada49f50d822b2c296f60b00471553a7b15;p=hippotat.git Makefile and docs framework Much copied from Otter. (Where needed, I am hereby relicensing from AGPLv3+ to GPLv3+.) Signed-off-by: Ian Jackson --- diff --git a/.gitignore b/.gitignore index ea8c4bf..812defb 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ /target +/docs/html +/docs/doctrees +/stamp diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..08b4dbf --- /dev/null +++ b/Makefile @@ -0,0 +1,49 @@ +# Copyright 2020-2021 Ian Jackson and contributors to Otter +# SPDX-License-Identifier: GPL-3.0-or-later +# There is NO WARRANTY. + +SHELL=/bin/bash + +default: all + +CARGO ?= cargo +TARGET_DIR ?= target + +SPHINXBUILD ?= sphinx-build + +ifneq (,$(wildcard ../Cargo.nail)) + +NAILING_CARGO ?= nailing-cargo +CARGO = $(NAILING_CARGO) +BUILD_SUBDIR ?= ../Build +TARGET_DIR = $(BUILD_SUBDIR)/$(notdir $(PWD))/target +NAILING_CARGO_JUST_RUN ?= $(NAILING_CARGO) --just-run -q --- + +else + +endif # Cargo.nail + +rsrcs = $(shell $(foreach x,$(MAKEFILE_FIND_X),set -$x;)\ + find -H $1 \( -name Cargo.toml -o -name Cargo.lock -o -name Cargo.lock.example -o -name \*.rs \) ) +stamp=@mkdir -p stamp; touch $@ + +all: cargo-build doc + +cargo-build: stamp/cargo-build + +stamp/cargo-build: $(call rsrcs,.) + $(NAILING_CARGO) build $(CARGO_BUILD_OPTIONS) + $(stamp) + +doc: docs/html/index.html + @echo 'Documentation can now be found here:' + @echo ' file://$(PWD)/$<' + +docs/html/index.html: docs/conf.py $(wildcard docs/*.md docs/*.rst docs/*.png) + $(SPHINXBUILD) -M html docs docs $(SPHINXOPTS) + +clean: + rm -rf stamp/* doc/html + $(NAILING_CARGO) clean + +.PHONY: cargo-build all doc clean diff --git a/README.md b/README.md new file mode 100644 index 0000000..c516b33 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +Introduction +============ diff --git a/docs/README.md b/docs/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..7a58ede --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,187 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- 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 = 'Otter' +copyright = '2021 Ian Jackson and the contributors to Otter' +author = 'Ian Jackson et al' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'recommonmark', + 'sphinx.ext.autosectionlabel', +] +autosectionlabel_prefix_document = True + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +#source_suffix = ['.rst', '.md'] +#source_suffix = '.rst' + +# https://github.com/readthedocs/recommonmark (retrieved 8.4.2021) +from recommonmark.parser import CommonMarkParser +source_parsers = { + '.md': CommonMarkParser, +} +source_suffix = { + '.rst': 'restructuredtext', + '.txt': 'markdown', + '.md': 'markdown', +} + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# 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 = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- 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 = 'classic' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# 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'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Otterdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Otter.tex', 'Otter Documentation', + 'Ian Jackson and the contributors to Otter', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'otter', 'Otter 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, 'Otter', 'Otter Documentation', + author, 'Otter', 'Online Table Top Environment Renderer', + 'Games'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..d9bbff9 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,15 @@ +Hippotat - Asinine IP over HTTP +=============================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + README + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search`