Skip to content

📚 Add a page on how to write sphinx extensions #736

Open
@chrisjsewell

Description

@chrisjsewell

I think it would be nice in the documentation here, to have a brief section about extending sphinx:

  1. How to do some "quick and dirty" things in your conf.py with the def setup(app: Sphinx) "hook" (e.g. as I have very much done in
    def setup(app: Sphinx):
    )
  2. Then possibly about how you might want to later extract this into a "fully fledged" extension package

Obviously we don't want to rehash, what is already in sphinx: https://www.sphinx-doc.org/en/master/development/index.html, but

@choldgraf I know you have written a few things about this in your blog (https://chrisholdgraf.com/blog/2023/social-directive/)
I wonder if you would be willing to add a little something here 😬 ?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions