Skip to content
Snippets Groups Projects
Commit ac77fe03 authored by Alán Muñoz's avatar Alán Muñoz
Browse files

update docs and bump version

parent 283fad61
No related branches found
No related tags found
No related merge requests found
numpydoc>=1.3.1 numpydoc>=1.3.1
aliby>=0.1.26 aliby>=0.1.26
myst-parser myst-parser
sphinx-autodoc-hints
...@@ -35,10 +35,23 @@ release = "0.1.26" ...@@ -35,10 +35,23 @@ release = "0.1.26"
extensions = [ extensions = [
"sphinx.ext.autodoc", # Core library for html generation from docstrings "sphinx.ext.autodoc", # Core library for html generation from docstrings
"sphinx.ext.autosummary", # Create neat summary tables "sphinx.ext.autosummary", # Create neat summary tables
"sphinx.ext.intersphinx", # Link to other project's documentation (see mapping below)
"sphinx.ext.viewcode", # Add a link to the Python source code for classes, functions etc.
"sphinx_autodoc_typehints", # Automatically document param types (less noise in class signature)
"numpydoc", # Play along with numpydoc format "numpydoc", # Play along with numpydoc format
"myst_parser", # Include markdown in rst files. "myst_parser", # Include markdown in rst files.
] ]
autosummary_generate = True # Turn on sphinx.ext.autosummary autosummary_generate = True # Turn on sphinx.ext.autosummary
autoclass_content = "both" # Add __init__ doc (ie. params) to class summaries
html_show_sourcelink = (
False # Remove 'view source code' from top of page (for html, not python)
)
autodoc_inherit_docstrings = True # If no docstring, inherit from base class
set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints
nbsphinx_allow_errors = True # Continue through Jupyter errors
# autodoc_typehints = "description" # Sphinx-native method. Not as good as sphinx_autodoc_typehints
add_module_names = False # Remove namespaces from class/method signatures
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
......
...@@ -3,30 +3,15 @@ ...@@ -3,30 +3,15 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
ALIBY's guides and documentation
=================================
.. toctree:: .. toctree::
:maxdepth: 3 :hidden:
Home page <self>
ALIBY reference <aliby>
extraction reference <extraction>
.. include:: ../../README.md .. include:: ../../README.md
:parser: myst_parser.sphinx_ :parser: myst_parser.sphinx_
Contributing
============
.. toctree::
:maxdepth: 2
.. include:: ../../CONTRIBUTING.md .. include:: ../../CONTRIBUTING.md
:parser: myst_parser.sphinx_ :parser: myst_parser.sphinx_
API Reference
============
.. toctree::
.. autosummary::
:template: custom-module-template.rst
:recursive:
aliby
extraction
[tool.poetry] [tool.poetry]
name = "aliby" name = "aliby"
version = "0.1.28" version = "0.1.29"
description = "Process and analyse live-cell imaging data" description = "Process and analyse live-cell imaging data"
authors = ["Alan Munoz <alan.munoz@ed.ac.uk>"] authors = ["Alan Munoz <alan.munoz@ed.ac.uk>"]
packages = [ packages = [
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment