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.

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

Already on GitHub? Sign in to your account

馃摎 Add a page on how to write sphinx extensions #736

Open
chrisjsewell opened this issue Mar 2, 2023 · 0 comments
Open

馃摎 Add a page on how to write sphinx extensions #736

chrisjsewell opened this issue Mar 2, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@chrisjsewell
Copy link
Member

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 馃槵 ?

@chrisjsewell chrisjsewell added the documentation Improvements or additions to documentation label Mar 2, 2023
@executablebooks executablebooks deleted a comment from welcome bot Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant