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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document the template module #44

Open
btel opened this issue Oct 1, 2020 · 0 comments
Open

document the template module #44

btel opened this issue Oct 1, 2020 · 0 comments

Comments

@btel
Copy link
Owner

btel commented Oct 1, 2020

What

template module allows for easy laying out the figure panels. It's useful, but not documented. Submit a PR that would add doc of the API and possibly a tutorial

How

you will need to learn a bit about sphinx: https://www.sphinx-doc.org/en/master/usage/quickstart.html and sphinx auto doc module: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

to see the examples checkout the docs directory in svg_utils repository

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

No branches or pull requests

2 participants