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

Snowflurry.dev docs rendering #307

Open
jlindon-anyon opened this issue Nov 13, 2023 · 1 comment
Open

Snowflurry.dev docs rendering #307

jlindon-anyon opened this issue Nov 13, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jlindon-anyon
Copy link

There are some rendering issues on snowflurry.dev,

  1. Equations are not rendering in documentation for functions such as Snowflurry.eye
  2. Backticks are not being removed when rendering <code> tags
  3. Blocks marked !!! warning are treated as regular text, e.g. below the is_gate_type function
@caffeine-storm caffeine-storm self-assigned this Nov 15, 2023
@caffeine-storm caffeine-storm added the documentation Improvements or additions to documentation label Nov 15, 2023
@fSosaRey
Copy link
Collaborator

as discussed offline, the docs need to be restructured slightly, and a second build using SnowflurryDocumenter (which will be made public).
A "postprocessing" script needs to be added to automate the manual reformatting.
The built markdown files will be imported to the website (private) repository as a submodule for automated deployment.

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

3 participants