Sphinx modifications

KissPeter · Sep 6, 2018 · e836578 · e836578
1 parent 2d33596
commit e836578
Show file tree

Hide file tree

Showing 12 changed files with 37 additions and 22 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,21 @@
+SHELL:=$(shell which bash)
+parent_dir:=$(shell dirname $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))))
+.PHONY: all
+all: clean
+all: apidoc
+all: sphinx
+
+SPHINXOPTS=-W -j 8 -d _build/doctrees .
+
+.PHONY: sphinx
+sphinx:
+	sphinx-build -b html $(SPHINXOPTS) _build/html
+
+.PHONY: clean
+clean:
+	rm -rf _build
+
+.PHONY: apidoc
+apidoc:
+	sphinx-apidoc  ../apifuzzer -f -e -o .
+
diff --git a/docs/apifuzzer/apifuzzer.base_template.rst → docs/apifuzzer.base_template.rst b/docs/apifuzzer/apifuzzer.base_template.rst → docs/apifuzzer.base_template.rst
@@ -1,5 +1,5 @@
-apifuzzer\.base\_template module
-================================
+apifuzzer.base\_template module
+===============================
 
 .. automodule:: apifuzzer.base_template
     :members:

diff --git a/docs/apifuzzer/apifuzzer.custom_fuzzers.rst → docs/apifuzzer.custom_fuzzers.rst b/docs/apifuzzer/apifuzzer.custom_fuzzers.rst → docs/apifuzzer.custom_fuzzers.rst
@@ -1,5 +1,5 @@
-apifuzzer\.custom\_fuzzers module
-=================================
+apifuzzer.custom\_fuzzers module
+================================
 
 .. automodule:: apifuzzer.custom_fuzzers
     :members:

diff --git a/docs/apifuzzer/apifuzzer.fuzzer_target.rst → docs/apifuzzer.fuzzer_target.rst b/docs/apifuzzer/apifuzzer.fuzzer_target.rst → docs/apifuzzer.fuzzer_target.rst
@@ -1,5 +1,5 @@
-apifuzzer\.fuzzer\_target module
-================================
+apifuzzer.fuzzer\_target module
+===============================
 
 .. automodule:: apifuzzer.fuzzer_target
     :members:

diff --git a/docs/apifuzzer/apifuzzer.rst → docs/apifuzzer.rst b/docs/apifuzzer/apifuzzer.rst → docs/apifuzzer.rst
diff --git a/docs/apifuzzer/apifuzzer.server_fuzzer.rst → docs/apifuzzer.server_fuzzer.rst b/docs/apifuzzer/apifuzzer.server_fuzzer.rst → docs/apifuzzer.server_fuzzer.rst
@@ -1,5 +1,5 @@
-apifuzzer\.server\_fuzzer module
-================================
+apifuzzer.server\_fuzzer module
+===============================
 
 .. automodule:: apifuzzer.server_fuzzer
     :members:

diff --git a/.../apifuzzer.swagger_template_generator.rst → .../apifuzzer.swagger_template_generator.rst b/.../apifuzzer.swagger_template_generator.rst → .../apifuzzer.swagger_template_generator.rst
@@ -1,5 +1,5 @@
-apifuzzer\.swagger\_template\_generator module
-==============================================
+apifuzzer.swagger\_template\_generator module
+=============================================
 
 .. automodule:: apifuzzer.swagger_template_generator
     :members:

diff --git a/...zer/apifuzzer.template_generator_base.rst → docs/apifuzzer.template_generator_base.rst b/...zer/apifuzzer.template_generator_base.rst → docs/apifuzzer.template_generator_base.rst
@@ -1,5 +1,5 @@
-apifuzzer\.template\_generator\_base module
-===========================================
+apifuzzer.template\_generator\_base module
+==========================================
 
 .. automodule:: apifuzzer.template_generator_base
     :members:

diff --git a/docs/apifuzzer/apifuzzer.utils.rst → docs/apifuzzer.utils.rst b/docs/apifuzzer/apifuzzer.utils.rst → docs/apifuzzer.utils.rst
@@ -1,5 +1,5 @@
-apifuzzer\.utils module
-=======================
+apifuzzer.utils module
+======================
 
 .. automodule:: apifuzzer.utils
     :members:

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,12 +4,4 @@ Table of contents
 =================
 
 .. toctree::
-    apifuzzer.apifuzzer.base_template
-    apifuzzer.apifuzzer.custom_fuzzers
-    apifuzzer.apifuzzer.fuzzer_target
-    apifuzzer.apifuzzer
-    apifuzzer.apifuzzer.server_fuzzer
-    apifuzzer.apifuzzer.swagger_template_generator
-    apifuzzer.apifuzzer.template_generator_base
-    apifuzzer.apifuzzer.utils
     modules
diff --git a/docs/apifuzzer/modules.rst → docs/modules.rst b/docs/apifuzzer/modules.rst → docs/modules.rst
diff --git a/test/requirements_for_test.txt b/test/requirements_for_test.txt
@@ -1,3 +1,5 @@
 Flask==1.0.2
 pytest==3.6.3
 pytest-cov==2.5.1
+sphinx
+sphinx_rtd_theme