Stowage/msgpack-python
2
0
Fork 0
mirror of https://github.com/msgpack/msgpack-python.git synced 2025-10-19 20:03:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

sphinx-related work (#554)

Browse source 
fixes #510
This commit is contained in:
TW 2023-08-31 05:56:24 +02:00 • committed by GitHub
parent 715126c67b
commit 7b75b4f368
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 59 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/_static/README.txt vendored Normal file
View file

@ -0,0 +1 @@
Sphinx will copy the contents of docs/_static/ directory to the build location.

8
docs/api.rst
View file

@ -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:

2
docs/conf.py
View file

@ -16,7 +16,7 @@ import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
# sys.path.insert(0, os.path.abspath('.'))
#sys.path.insert(0, os.path.abspath('..'))
# -- General configuration -----------------------------------------------------