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.

Sign up for GitHub

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

Jump to bottom

Docs: split api.md #96

Open
PMeira opened this issue Nov 2, 2023 · 3 comments
Open

Docs: split api.md #96

PMeira opened this issue Nov 2, 2023 · 3 comments
Labels
docs

Comments

@PMeira
Copy link
Member

PMeira commented Nov 2, 2023

The generated HTML is beyond the default size threshold and running newer Documenter versions result in an error. I'm setting it to ignore that, but we should probably split that file.

This is not an urgent issue; more of an SEO issue than anything.
@PMeira PMeira added the docs label Nov 2, 2023
@PMeira
Copy link
Member Author

PMeira commented Feb 13, 2024

One other issue I noticed is that the function signatures are not listed, which can cause confusion for new Julia users.

@tshort
Copy link
Collaborator

tshort commented Feb 13, 2024

One option to add method signatures is to use DocStringExtensions.jl.

@PMeira
Copy link
Member Author

PMeira commented Feb 18, 2024

One option to add method signatures is to use DocStringExtensions.jl.

That was it! It's already used but it wasn't imported in circuit.jl.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tshort @PMeira