From 27aa819df47c9690e5e0be2fe3a3a39b46f08857 Mon Sep 17 00:00:00 2001 From: kianfar77 Date: Fri, 11 Oct 2019 10:31:32 -0700 Subject: [PATCH 1/2] livehtml --- docs/Makefile | 5 ++++- docs/source/conf.py | 9 ++++++--- docs/source/modules.rst | 2 +- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index ba501f6f5..cb530b74a 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -6,7 +6,7 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build SOURCEDIR = source BUILDDIR = build - +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) $(SOURCEDIR) # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) @@ -17,3 +17,6 @@ help: # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +livehtml: + sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html diff --git a/docs/source/conf.py b/docs/source/conf.py index 8b055c626..5f562cd6b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -100,13 +100,16 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # -# html_theme_options = {} +html_theme_options = { + # Toc options + 'sticky_navigation': True +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -211,4 +214,4 @@ # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True -# \ No newline at end of file +# diff --git a/docs/source/modules.rst b/docs/source/modules.rst index e55c4d361..2429f4dbc 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -1,7 +1,7 @@ Python API ========== -.. automodule:: db_genomics.dbg +.. automodule:: glow.glow :members: :undoc-members: :show-inheritance: From 68bf259a685982a12b337706bc6cf145fedb1486 Mon Sep 17 00:00:00 2001 From: kianfar77 Date: Fri, 11 Oct 2019 11:51:44 -0700 Subject: [PATCH 2/2] fix --- docs/source/conf.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 5f562cd6b..e29487e26 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -100,16 +100,13 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # -html_theme_options = { - # Toc options - 'sticky_navigation': True -} +# html_theme_options = {} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files,