Skip to content

fix doc building and regenerate #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rhpvorderman merged 2 commits into from
Apr 26, 2019
Merged

fix doc building and regenerate #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc23a03
fix doc building
martenson Apr 25, 2019
e6ec1cf
build docs
martenson Apr 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ coverage:
open htmlcov/index.html || xdg-open htmlcov/index.html

docs:
$(IN_VENV) sphinx-apidoc -f -o docs/ ephemeris
$(IN_VENV) sphinx-apidoc -f -o docs/ src/ephemeris
$(IN_VENV) $(MAKE) -C docs clean
$(IN_VENV) $(MAKE) -C docs html

Expand Down
3 changes: 2 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,12 @@
# Get the project root dir, which is the parent dir of this
cwd = os.getcwd()
project_root = os.path.dirname(cwd)
source = (os.path.join(project_root, 'src'))

# Insert the project root dir as the first element in the PYTHONPATH.
# This lets us ensure that the source package is imported, and that its
# version is used.
sys.path.insert(0, project_root)
sys.path.insert(0, source)

import sphinx_rtd_theme

Expand Down
52 changes: 34 additions & 18 deletions docs/ephemeris.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,72 +4,88 @@ ephemeris package
Submodules
----------

ephemeris\.common\_parser module
--------------------------------
ephemeris.common\_parser module
-------------------------------

.. automodule:: ephemeris.common_parser
:members:
:undoc-members:
:show-inheritance:

ephemeris\.ephemeris\_log module
--------------------------------
ephemeris.ephemeris\_log module
-------------------------------

.. automodule:: ephemeris.ephemeris_log
:members:
:undoc-members:
:show-inheritance:

ephemeris\.generate\_tool\_list\_from\_ga\_workflow\_files module
-----------------------------------------------------------------
ephemeris.generate\_tool\_list\_from\_ga\_workflow\_files module
----------------------------------------------------------------

.. automodule:: ephemeris.generate_tool_list_from_ga_workflow_files
:members:
:undoc-members:
:show-inheritance:

ephemeris\.get\_tool\_list\_from\_galaxy module
-----------------------------------------------
ephemeris.get\_tool\_list\_from\_galaxy module
----------------------------------------------

.. automodule:: ephemeris.get_tool_list_from_galaxy
:members:
:undoc-members:
:show-inheritance:

ephemeris\.run\_data\_managers module
-------------------------------------
ephemeris.run\_data\_managers module
------------------------------------

.. automodule:: ephemeris.run_data_managers
:members:
:undoc-members:
:show-inheritance:

ephemeris\.setup\_data\_libraries module
----------------------------------------
ephemeris.setup\_data\_libraries module
---------------------------------------

.. automodule:: ephemeris.setup_data_libraries
:members:
:undoc-members:
:show-inheritance:

ephemeris\.shed\_tools module
-----------------------------
ephemeris.shed\_tools module
----------------------------

.. automodule:: ephemeris.shed_tools
:members:
:undoc-members:
:show-inheritance:

ephemeris\.sleep module
-----------------------
ephemeris.shed\_tools\_args module
----------------------------------

.. automodule:: ephemeris.shed_tools_args
:members:
:undoc-members:
:show-inheritance:

ephemeris.shed\_tools\_methods module
-------------------------------------

.. automodule:: ephemeris.shed_tools_methods
:members:
:undoc-members:
:show-inheritance:

ephemeris.sleep module
----------------------

.. automodule:: ephemeris.sleep
:members:
:undoc-members:
:show-inheritance:

ephemeris\.workflow\_install module
-----------------------------------
ephemeris.workflow\_install module
----------------------------------

.. automodule:: ephemeris.workflow_install
:members:
Expand Down
⚡