doc: initial groundwork for documentation

532f38a7 · Dimitris Lampridis · 4c93c692 · 532f38a7 · 532f38a7 · 532f38a7
Commit 532f38a7 authored Jan 25, 2019 by Dimitris Lampridis
7 changed files
--- a/doc/.gitignore
+++ b/doc/.gitignore
-doxy-wrtd
\ No newline at end of file
+doxygen-output/
+*.log
+_build
+build_env
--- a/doc/Makefile
+++ b/doc/Makefile
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = wrtd
+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 doxygen doxygen-clean
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+
+
+%: Makefile
+	$(MAKE) doxygen TARGET=$@
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
 GIT_VERSION = $(shell cd $(src); git describe --dirty --long --tags)

-O ?= doxy-wrtd
+DOXY_OUT ?= doxygen-output

 # Build the documentation with or without the internals details
 ifdef SHOW_INTERNALS
@@ -11,13 +36,11 @@ else
 	BRIEF = "API Documentation"
 endif

-all: doxygen
-
 doxygen:
+ifeq ($(TARGET),clean)
+	@echo "Remove Doxygen files"
+	@rm -rf $(DOXY_OUT) $(BUILDDIR)
+else
 	GIT_VERSION=$(GIT_VERSION) EXCLUDE_FILES=$(EXCLUDE_FILES) BRIEF=$(BRIEF) \
-	OUTPUT=$(O) doxygen ./doxygen-wrtd-config
-
-clean:
-	rm -rf $(O)
-# Latex stuff
-	rm -f *.dvi *.aux *.out *.log *.backup
+	OUTPUT=$(DOXY_OUT) doxygen ./doxygen-wrtd-config
+endif
--- a/doc/conf.py
+++ b/doc/conf.py
--- a/doc/doxygen-wrtd-config
+++ b/doc/doxygen-wrtd-config
-PROJECT_NAME           = "White Rabbit Trigger Distribution - Software"
+PROJECT_NAME           = "White Rabbit Trigger Distribution"
 PROJECT_NUMBER         = $(GIT_VERSION)
 PROJECT_BRIEF          = $(BRIEF)
 PROJECT_LOGO           =

--- a/doc/index.rst
+++ b/doc/index.rst
+.. White Rabbit Trigger Distribution documentation master file, created by
+   sphinx-quickstart on Fri Jan 25 09:42:58 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+White Rabbit Trigger Distribution documentation
+===============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   introduction
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
--- a/doc/introduction.md
+++ b/doc/introduction.md
+Introduction
+============
+
+`Hello` *there* [link](https://ohwr.org)
+
+- item 1
+- item 2
+
+[dictionary](dictionary.md)
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
+docutils==0.14
+Sphinx==1.8.3
+sphinx_rtd_theme
+breathe==4.10.0
+recommonmark==0.5.0