docs: add api doc and use the previous spiders doc

Signed-off-by: Spiros Delviniotis <spirosdelviniotis@gmail.com>
inspirehep · May 12, 2017 · 158e324 · 158e324
1 parent bd1b9b9
commit 158e324
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 16 deletions.
diff --git a/docker-compose.test.yml b/docker-compose.test.yml
@@ -37,7 +37,7 @@ services:
     image: hepcrawl_base
     environment: *env_variables
     tty: true
-    command: bash -c "py.test tests/unit -vv && sphinx-build -nNW docs docs/_build/html && python setup.py sdist && ls dist/*"
+    command: bash -c "py.test tests/unit -vv && make -C docs html && python setup.py sdist && ls dist/*"
     volumes: *common_volumes
 
   celery:

diff --git a/docs/Makefile b/docs/Makefile
@@ -24,7 +24,7 @@ PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-SPHINXAPIDOC    = sphinx-apidoc -f -o $(SOURCEDIR) $(CODEDIR)
+SPHINXAPIDOC    = sphinx-apidoc -M -P -f -o $(SOURCEDIR) $(CODEDIR) -E $(CODEDIR)/spiders
 
 .PHONY: help
 help:

diff --git a/docs/index.rst b/docs/index.rst
@@ -48,7 +48,8 @@ this part of the documentation is for you.
 .. toctree::
    :maxdepth: 2
 
-   _source/hepcrawl
+   _source/hepcrawl.rst
+   spiders
 
 Additional Notes
 ----------------

diff --git a/docs/api.rst → docs/spiders.rst b/docs/api.rst → docs/spiders.rst
@@ -9,19 +9,6 @@
 .. currentmodule:: hepcrawl
 
 
-API
-===
-
-.. automodule:: hepcrawl
-   :members:
-
-Items
------
-
-.. automodule:: hepcrawl.items
-   :members:
-
-
 Spiders
 -------