jami-docs

commit 59fe3fe5fc47c5932b261afd787cb2735f6c47c2
parent 86a20e72363cf7a13aa42e811d000b1e5b560f9f
Author: Nick Econopouly <wry@mm.st>
Date:   Fri, 19 Feb 2021 15:54:52 -0500

Update doc contribution guide and add makefile

Diffstat:
A
Makefile
 | 
20
++++++++++++++++++++
M
guides/how-to-contribute-to-this-documentation.txt
 | 
5
++---

2 files changed, 22 insertions(+), 3 deletions(-)
diff --git a/Makefile b/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/guides/how-to-contribute-to-this-documentation.txt b/guides/how-to-contribute-to-this-documentation.txt
@@ -53,8 +53,7 @@ Pages are written in either markdown or `reStructuredText
 can click "View page source" at the top of any page to see how the
 page was written.
 
-Go ahead and make your changes to ``.rst`` or ``.md`` files in the
-``source`` folder.
+Go ahead and make your changes to the ``.rst`` or ``.md`` files.
 
 Previewing your work
 =======================================
@@ -66,7 +65,7 @@ From the base of the repository, run:
 	$ make html
 
 You should now be able to view the documentation in your web
-browser. The homepage is at ``build/html/index.html``.
+browser. The homepage is at ``_build/html/index.html``.
 
 Saving your work
 ================================================