Skip to content
This repository has been archived by the owner on Feb 17, 2022. It is now read-only.

docs: autodoc failure at rtfd.org #36

Closed
tiborsimko opened this issue Aug 30, 2015 · 4 comments · Fixed by #40
Closed

docs: autodoc failure at rtfd.org #36

tiborsimko opened this issue Aug 30, 2015 · 4 comments · Fixed by #40
Assignees
Labels
Milestone

Comments

@tiborsimko
Copy link
Member

The doc building at rtfd.org does not generate auto-documentation properly:

Locally, everything is fine.

We should either (1) investigate and fix this failure at rtfd.org or (2) move documentation to pythonhosted.org.

@tiborsimko tiborsimko self-assigned this Aug 30, 2015
@tiborsimko tiborsimko added this to the v0.2.0 milestone Aug 30, 2015
@tiborsimko
Copy link
Member Author

@lnielsen I think you saw the same troubles with Flask-AppFactory?

tiborsimko added a commit to tiborsimko/claimstore that referenced this issue Aug 31, 2015
* Amends capitalisation of Pythonic pre-requisites, e.g. `Flask` instead
  of `flask`, in order to make `python setup.py install` working.
  Consequently, this makes the autodoc documentation building at RTFD
  working in their virtual environments.  (closes inveniosoftware#36)

Signed-off-by: Tibor Simko <tibor.simko@cern.ch>
@tiborsimko
Copy link
Member Author

OK, problem understood:

  • need to build in their own virtual environments with CPython 3.x; however this lead to an error message flask not being installable...
  • need to amend pre-requisite uppercase/lowercase (e.g. Flask instead of flask) so that python setup.py install would be working

@tiborsimko
Copy link
Member Author

The setup step is now OK:

[...]
Finished processing dependencies for claimstore==0.1.0.dev20150821

but the autodoc step still fails:

Running Sphinx v1.3.1
making output directory...
loading translations [en]... done
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [readthedocs]: targets for 6 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] api

/home/docs/checkouts/readthedocs.org/user_builds/claimstore/checkouts/latest/docs/api.rst:15: WARNING: autodoc: failed to import module 'claimstore.app'; the following exception was raised:
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/claimstore/envs/latest/local/lib/python3.4/site-packages/sphinx/ext/autodoc.py", line 385, in import_object
    __import__(self.modname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/claimstore/envs/latest/local/lib/python3.4/site-packages/claimstore-0.1.0.dev20150821-py3.4.egg/claimstore/app.py", line 26, in <module>
    from claimstore.core.exception import RestApiException
ImportError: No module named 'claimstore.core'
[...]

@tiborsimko tiborsimko reopened this Aug 31, 2015
tiborsimko added a commit to tiborsimko/claimstore that referenced this issue Aug 31, 2015
* Adds installation, testing and documentation section to the project
  README file.

* Adds `currentmodule` for RTFD.  (addresses inveniosoftware#36)

Signed-off-by: Tibor Simko <tibor.simko@cern.ch>
tiborsimko added a commit to tiborsimko/claimstore that referenced this issue Aug 31, 2015
* Updates license version to GNU GPLv3.

* Amends `docs/conf.py` WRT import path for autodoc.  (addresses inveniosoftware#36)

Signed-off-by: Tibor Simko <tibor.simko@cern.ch>
tiborsimko added a commit to tiborsimko/claimstore that referenced this issue Aug 31, 2015
* Updates license version to GNU GPLv3.

* Amends `docs/conf.py` WRT import path for autodoc.  (addresses inveniosoftware#36)

Signed-off-by: Tibor Simko <tibor.simko@cern.ch>
tiborsimko added a commit to tiborsimko/claimstore that referenced this issue Aug 31, 2015
* Updates license version to GNU GPLv3.

* Amends `docs/conf.py` WRT import path for autodoc.  (addresses inveniosoftware#36)

Signed-off-by: Tibor Simko <tibor.simko@cern.ch>
@tiborsimko
Copy link
Member Author

Solved by a6d3519:

diff --git a/docs/conf.py b/docs/conf.py
index a3900d3..9c05370 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -18,7 +18,7 @@ import os
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))

(CC @jirikuncar @lnielsen @jbenito3 for information)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant