feat: docs building #1
Conversation
|
Thoughts from viewing the demo:
That is actually my only note, it looks amazing! |
| @@ -1,6 +1,6 @@ | |||
| # Quick Start | |||
|
|
|||
| TODO: Description | |||
| A script that uses sphinx to develop documentation for ApeWorX plugins. | |||
There was a problem hiding this comment.
refactor idea: We can make this less of a script and more of a package / sphinx plugin (at some point).
Something like:
from ape_plugins_docs import build_docs(btw not saying we really need to publish this to pypi, only talking about the usage)
I'm thinking of asking Alex to combine the icon and name in one long logo instead to make it easier to see on the docs page since it does look really small there. I don't think there's a way to have 2 images side by side for the logo natively |
README.md
Outdated
|
|
||
| ```bash | ||
| pip install docs-build | ||
| ``` | ||
| - name: Clone ape-docs-build |
There was a problem hiding this comment.
idea: Perhaps we should make a custom github actions so users can do:
uses: ApeWorX/ape-docs-build
There was a problem hiding this comment.
I tried working on making it a custom github action but I think I would have to rework some of it because of how I currently have it setup.
| f.write(REDIRECT_HTML.format(redirect)) | ||
|
|
||
|
|
||
| if __name__ == "__main__": |
There was a problem hiding this comment.
another idea: it may be nice to make this a click script instead.
we need to keep in mind developers wanting to build and run the docs locally to test changes to their plugins.
if the script is only available in CI/CD, they won't be able to do that!
Also, if we make it a click script, it'd be easy to eventually add it to the ape plugins docs commands
There was a problem hiding this comment.
One thing to do I just realized:
- Describe in the README how to build docs for a plugin locally as a developer
- Improve the dev-ex of building and serving docs locally
Part 2 can come in waves or in a later PR. Stuff like making it a CLI / click-script or adding it to ape plugins docs command or both..
In any case, developers are going to want to build docs locally
What I did
Build plugin docs using sphinx.
fixes: #APE-243
How I did it
How to verify it
This is how the docs looks when it builds the repo through github actions: https://dtdang.github.io/ape-vyper/latest/
Checklist