Skip to content
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

Jump to bottom

sphinx-related work #554

Merged
merged 8 commits into from
Aug 31, 2023
Merged

sphinx-related work #554

merged 8 commits into from
Aug 31, 2023

Commits on Aug 26, 2023

  1. docs: adjust comment about sys.path 

    note that it is usually not needed to tweak sys.path, one just needs to have
msgpack installed (like into a currently active venv) and it will be found.

i adjusted the path in the comment nevertheless, so if somebody wants the
stuff in docs/../msgpack to be found, it just needs to be uncommented.

sys.path tweaking might also cause issues i guess, e.g. if docs/../msgpack
is found first and stuff from there is tried, instead of a correctly installed
msgpack somewhere else in sys.path.
    @ThomasWaldmann
    ThomasWaldmann committed Aug 26, 2023
    Configuration menu
    Copy the full SHA
    fc2e6ad View commit details
    Browse the repository at this point in the history

  2. tox: add sphinx testenv

    @ThomasWaldmann
    ThomasWaldmann committed Aug 26, 2023
    Configuration menu
    Copy the full SHA
    b14d743 View commit details
    Browse the repository at this point in the history

  3. github: build the docs

    @ThomasWaldmann
    ThomasWaldmann committed Aug 26, 2023
    Configuration menu
    Copy the full SHA
    479b6b5 View commit details
    Browse the repository at this point in the history

  4. sphinx: add docs/_static to avoid warning

    @ThomasWaldmann
    ThomasWaldmann committed Aug 26, 2023
    Configuration menu
    Copy the full SHA
    74fb0f4 View commit details
    Browse the repository at this point in the history

  5. fix sphinx warnings in ext.py

    @ThomasWaldmann
    ThomasWaldmann committed Aug 26, 2023
    Configuration menu
    Copy the full SHA
    85c272b View commit details
    Browse the repository at this point in the history

  6. 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
    @ThomasWaldmann
    ThomasWaldmann committed Aug 26, 2023
    Configuration menu
    Copy the full SHA
    7a59dab View commit details
    Browse the repository at this point in the history

  7. fix py:meth reference target not found 

    msgpack.fallback.Unpacker:6: WARNING: py:meth reference target not found: feed
    @ThomasWaldmann
    ThomasWaldmann committed Aug 26, 2023
    Configuration menu
    Copy the full SHA
    487f889 View commit details
    Browse the repository at this point in the history

  8. fix warnings related to callable type 

    WARNING: py:class reference target not found: callable
    @ThomasWaldmann
    ThomasWaldmann committed Aug 26, 2023
    Configuration menu
    Copy the full SHA
    1c4f7d1 View commit details
    Browse the repository at this point in the history