From be72a82c666fa8f0fec4e0a378ddc79dc647d8a6 Mon Sep 17 00:00:00 2001 From: adamgayoso Date: Wed, 24 Feb 2021 08:21:27 -0800 Subject: [PATCH 1/2] update documentation settings --- docs/conf.py | 85 ++----------------------------------------- docs/requirements.txt | 10 ----- 2 files changed, 3 insertions(+), 92 deletions(-) delete mode 100644 docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index d880d21..339a7f9 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -70,42 +70,12 @@ napoleon_google_docstring = False napoleon_numpy_docstring = True napoleon_include_init_with_doc = False -napoleon_use_rtype = True # having a separate entry generally helps readability +napoleon_use_rtype = True napoleon_use_param = True napoleon_custom_sections = [("Params", "Parameters")] todo_include_todos = False numpydoc_show_class_members = False -annotate_defaults = True # scanpydoc option, look into why we need this -nbsphinx_prolog = r""" -.. raw:: html - - - -{% set docname = env.doc2path(env.docname, base=None).split("/")[-1] %} - -.. raw:: html - -
-

Note

-

- This page was generated from - {{ docname|e }}. - Interactive online version: - Colab badge. -

-
-""" +annotate_defaults = True # The master toctree document. master_doc = "index" @@ -208,7 +178,7 @@ # -- Options for HTMLHelp output --------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = "scvidoc" +htmlhelp_basename = "skeletondoc" mathjax_config = { "extensions": ["tex2jax.js"], @@ -219,52 +189,3 @@ "processEscapes": True, }, } - -# -- Options for LaTeX output ------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass -# [howto, manual, or own class]). -latex_documents = [ - (master_doc, "scvi.tex", u"mypackage Documentation", u"Adam Gayoso", "manual") -] - - -# -- Options for manual page output ------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "mypackage", u"mypackage Documentation", [author], 1)] - - -# -- Options for Texinfo output ---------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "mypackage", - u"mypackage Documentation", - author, - "scvi", - "One line description of project.", - "Miscellaneous", - ) -] diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 631b3fc..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -sphinx_rtd_theme>=0.3.1 -sphinx>=2.0.1 -nbsphinx -sphinx-autodoc-typehints -sphinx-material -nbsphinx-link -ipython -scanpydoc>=0.4.5 -pydata-sphinx-theme>=0.4.0 -typing_extensions; python_version < '3.8' From 6f7edca6a657d4fa5b89cb29929e230f97190e0f Mon Sep 17 00:00:00 2001 From: adamgayoso Date: Wed, 24 Feb 2021 08:25:48 -0800 Subject: [PATCH 2/2] bump version --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 7067ab1..29f603a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,7 +26,7 @@ packages = [ {include = "mypackage"}, ] readme = "README.md" -version = "0.2.0" +version = "0.2.1" [tool.poetry.dependencies] anndata = ">=0.7.5"