Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
aliby-mirror
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Swain Lab
aliby
aliby-mirror
Commits
ac77fe03
Commit
ac77fe03
authored
2 years ago
by
Alán Muñoz
Browse files
Options
Downloads
Patches
Plain Diff
update docs and bump version
parent
283fad61
No related branches found
No related tags found
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
docs/requirements.txt
+1
-0
1 addition, 0 deletions
docs/requirements.txt
docs/source/conf.py
+13
-0
13 additions, 0 deletions
docs/source/conf.py
docs/source/index.rst
+5
-20
5 additions, 20 deletions
docs/source/index.rst
pyproject.toml
+1
-1
1 addition, 1 deletion
pyproject.toml
with
20 additions
and
21 deletions
docs/requirements.txt
+
1
−
0
View file @
ac77fe03
numpydoc>=1.3.1
numpydoc>=1.3.1
aliby>=0.1.26
aliby>=0.1.26
myst-parser
myst-parser
sphinx-autodoc-hints
This diff is collapsed.
Click to expand it.
docs/source/conf.py
+
13
−
0
View file @
ac77fe03
...
@@ -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.
...
...
This diff is collapsed.
Click to expand it.
docs/source/index.rst
+
5
−
20
View file @
ac77fe03
...
@@ -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
This diff is collapsed.
Click to expand it.
pyproject.toml
+
1
−
1
View file @
ac77fe03
[tool.poetry]
[tool.poetry]
name
=
"aliby"
name
=
"aliby"
version
=
"0.1.2
8
"
version
=
"0.1.2
9
"
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
=
[
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment