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

Add a high-level description of the API first on /syntax.html #35

Closed
choldgraf opened this issue Sep 21, 2020 · 2 comments
Closed

Add a high-level description of the API first on /syntax.html #35

choldgraf opened this issue Sep 21, 2020 · 2 comments

Comments

@choldgraf
Copy link
Member

I found it a little bit confusing that the first example starts with {proof:proof}. I think if there were a short section like "all directives in this package follow the pattern {proof:<title>} or something like this, I may have been a bit less-confused. Just sharing in case it's helpful!

@najuzilu
Copy link
Member

How's this:

This package utilizes a Sphinx domain - named "proof" - to describe and link typeset markup objects (theorems, proofs, corollaries, etc.) which we think belong together. All directives follow the pattern {<domain_name>:<typeset>} while all the roles follow the pattern {<domain_name>:ref}. To utilize any directive in the proof domain follow the pattern {proof:<typeset>}. To reference any directive follow the pattern {proof:ref}.

@najuzilu
Copy link
Member

Closing since this has been addressed here #39.

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

No branches or pull requests

2 participants