Skip to content

Conversation

@lwasser
Copy link
Member

@lwasser lwasser commented Apr 28, 2024

This needs review.
i still don't understand how to connect python code to a sphinx build and what that should look like.

Features

  • this also parses EVERY commit for every md file. I think we want to only do that one time and then do it for recent commits in the future. i'm not sure what the best practice is for that related to a sphinx build

  • this uses pygithub. i've noticed the maintenance can be a bit spotty. we could do the same thing easily with requests and dump the dependency.

  • Sphinx-build doesn't currently work. even if the extension is installed, it can't find it. sphinx-build -b html . _build/html
    Running Sphinx v7.3.7

Extension error:
Could not import extension sphinx-contribs (exception: No module named 'sphinx-contribs')
(contributors)

docs/conf.py Outdated
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = ["sphinx-contribs"]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now, even if i install this extension, sphinx can't "see" or find it when you run sphinx-build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant