Remove vulnerabilities.rst

vstinner · vstinner · commit b9e0e45b5ccf · 2017-02-24T13:20:30.000+01:00
* "make" should now build everything
* Add requirements.txt: PyYAML
* Add setup.py: run render_doc.py
diff --git a/Makefile b/Makefile
@@ -1,24 +1,23 @@
-# Minimal makefile for Sphinx documentation
-#
-
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = PythonSecurity
 SOURCEDIR     = .
 BUILDDIR      = build
 
-all:
-	./venv/bin/python render_doc.py
+.PHONY: html
+
+doc: html
 	make html
 
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+venv:
+	./venv.sh
 
-.PHONY: help Makefile
+vulnerabilities.rst: vulnerabilities.yml venv
+	./venv/bin/python render_doc.py
 
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+html: vulnerabilities.rst
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -rf vulnerabilities.rst build/ venv/
diff --git a/README.rst b/README.rst
@@ -1 +1,27 @@
 Python Security documentation: http://python-security.readthedocs.io/
+
+Input files:
+
+* ``vulnerabilities.yml``: Python vulnerabilities 2007-2017, see the commented
+  template at the end to add a new entry
+* ``python_releases.txt``: Python release dates 2.5.0-3.6.0
+
+Cache files:
+
+* ``commit_dates.txt``
+* ``commit_tags.txt``
+
+Build the doc::
+
+    make
+
+Build without Makefile::
+
+    ./venv.sh
+    ./venv/bin/python render_doc.py
+    sphinx-build -M html . build
+
+For ReadTheDocs.org, other files are used:
+
+* ``requirements.txt``
+* ``setup.py``: run render_doc.py
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+PyYAML
diff --git a/setup.py b/setup.py
@@ -0,0 +1,7 @@
+#!/usr/bin/env python3
+import os, subprocess, sys
+script = 'render_doc.py'
+# render_doc.py
+print("Run %s" % script)
+args = [sys.executable, script]
+os.execv(args[0], args)
diff --git a/venv.sh b/venv.sh
@@ -3,4 +3,4 @@ set -e -x
 python3 -m venv --without-pip venv
 wget https://bootstrap.pypa.io/get-pip.py
 venv/bin/python get-pip.py
-venv/bin/python -m pip install -U PyYAML
+venv/bin/python -m pip install -r requirements.txt
diff --git a/vulnerabilities.rst b/vulnerabilities.rst
