Skip to content

sphinx-related work #554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
methane merged 8 commits into from
Aug 31, 2023
Merged

sphinx-related work #554

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fc2e6ad
docs: adjust comment about sys.path
ThomasWaldmann Aug 25, 2023
b14d743
tox: add sphinx testenv
ThomasWaldmann Aug 25, 2023
479b6b5
github: build the docs
ThomasWaldmann Aug 25, 2023
74fb0f4
sphinx: add docs/_static to avoid warning
ThomasWaldmann Aug 25, 2023
85c272b
fix sphinx warnings in ext.py
ThomasWaldmann Aug 25, 2023
7a59dab
fix py:func reference target not found
ThomasWaldmann Aug 25, 2023
487f889
fix py:meth reference target not found
ThomasWaldmann Aug 25, 2023
1c4f7d1
fix warnings related to callable type
ThomasWaldmann Aug 25, 2023
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
Prev Previous commit
Next Next commit
fix py:func reference target not found 
Fixes:
 WARNING: py:func reference target not found: dump
WARNING: py:func reference target not found: dumps
WARNING: py:func reference target not found: load
WARNING: py:func reference target not found: loads
  • Loading branch information
@ThomasWaldmann
ThomasWaldmann committed Aug 26, 2023
commit 7a59dab0e67b85249a3823541515bbe81c37be6f
8 changes: 4 additions & 4 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ API reference

.. autofunction:: pack

:func:`dump` is alias for :func:`pack`
``dump()`` is an alias for :func:`pack`

.. autofunction:: packb

:func:`dumps` is alias for :func:`packb`
``dumps()`` is an alias for :func:`packb`

.. autofunction:: unpack

:func:`load` is alias for :func:`unpack`
``load()`` is an alias for :func:`unpack`

.. autofunction:: unpackb

:func:`loads` is alias for :func:`unpackb`
``loads()`` is an alias for :func:`unpackb`

.. autoclass:: Packer
:members:
Expand Down