fix sphinx documentation issues (call it through the right namespace)

This commit is contained in:
Dave Halter
2014-03-11 14:17:16 +01:00
parent 8aa71d7cd6
commit 90338aa828
3 changed files with 15 additions and 15 deletions

View File

@@ -57,12 +57,12 @@ because that's where all the magic happens. I need to introduce the :ref:`parser
Parser (parser/__init__.py) Parser (parser/__init__.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: parser .. automodule:: jedi.parser
Parser Representation (parser/representation.py) Parser Representation (parser/representation.py)
++++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++++
.. automodule:: parser.representation .. automodule:: jedi.parser.representation
Class inheritance diagram: Class inheritance diagram:
@@ -87,12 +87,12 @@ Class inheritance diagram:
Evaluation of python code (evaluate/__init__.py) Evaluation of python code (evaluate/__init__.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: evaluate .. automodule:: jedi.evaluate
Evaluation Representation (evaluate/representation.py) Evaluation Representation (evaluate/representation.py)
++++++++++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. automodule:: evaluate.representation .. automodule:: jedi.evaluate.representation
.. inheritance-diagram:: .. inheritance-diagram::
Executable Executable
@@ -137,7 +137,7 @@ without some features.
Dynamic Arrays & Function Parameters (dynamic.py) Dynamic Arrays & Function Parameters (dynamic.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: evaluate.dynamic .. automodule:: jedi.evaluate.dynamic
.. _fast_parser: .. _fast_parser:
@@ -145,21 +145,21 @@ Dynamic Arrays & Function Parameters (dynamic.py)
Fast Parser (parser/fast.py) Fast Parser (parser/fast.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: parser.fast .. automodule:: jedi.parser.fast
.. _docstrings: .. _docstrings:
Docstrings (docstrings.py) Docstrings (docstrings.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: evaluate.docstrings .. automodule:: jedi.evaluate.docstrings
.. _refactoring: .. _refactoring:
Refactoring (refactoring.py) Refactoring (refactoring.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: refactoring .. automodule:: jedi.refactoring
.. _imports-modules: .. _imports-modules:
@@ -178,7 +178,7 @@ Imports & Modules
Compiled Modules (compiled.py) Compiled Modules (compiled.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: evaluate.compiled .. automodule:: jedi.evaluate.compiled
.. _imports: .. _imports:
@@ -186,7 +186,7 @@ Compiled Modules (compiled.py)
Imports (imports.py) Imports (imports.py)
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. automodule:: evaluate.imports .. automodule:: jedi.evaluate.imports
@@ -204,14 +204,14 @@ Caching & Recursions
Caching (cache.py) Caching (cache.py)
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
.. automodule:: cache .. automodule:: jedi.cache
.. _recursion: .. _recursion:
Recursions (recursion.py) Recursions (recursion.py)
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: evaluate.recursion .. automodule:: jedi.evaluate.recursion
@@ -228,4 +228,4 @@ Jedi works.
Python 2/3 compatibility (_compatibility.py) Python 2/3 compatibility (_compatibility.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: _compatibility .. automodule:: jedi._compatibility

View File

@@ -5,6 +5,6 @@
API Return Classes API Return Classes
------------------ ------------------
.. automodule:: api.classes .. automodule:: jedi.api.classes
:members: :members:
:undoc-members: :undoc-members:

View File

@@ -3,4 +3,4 @@
Settings Settings
======== ========
.. automodule:: settings .. automodule:: jedi.settings