Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ junit-*.xml
docs/source/*.model
docs/source/*.pkl
docs/source/*.tl
docs/source/*.joblib

## autosummary-generated API reference stubs
docs/source/api/generated/

## Sphinx build output
docs/build/
docs/_html/

## eclipse
.project
Expand Down
2 changes: 1 addition & 1 deletion docs/source/FIL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ FIL is ideal for many scenarios:
API Reference
=============

See the :doc:`API reference <api>` for the API documentation.
See the :doc:`API reference <api/index>` for the API documentation.

Migration Guide
===============
Expand Down
26 changes: 26 additions & 0 deletions docs/source/_templates/autosummary/base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{{ objname | escape | underline(line="=") }}

{% if objtype == "module" -%}

.. automodule:: {{ fullname }}

{%- elif objtype == "function" -%}

.. currentmodule:: {{ module }}

.. autofunction:: {{ objname }}

{%- elif objtype == "class" -%}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
:members:

{%- else -%}

.. currentmodule:: {{ module }}

.. auto{{ objtype }}:: {{ objname }}

{%- endif -%}
Loading
Loading