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

Automatically generate and publish API documentation #279

Open
mithro opened this issue Apr 27, 2020 · 3 comments
Open

Automatically generate and publish API documentation #279

mithro opened this issue Apr 27, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@mithro
Copy link
Collaborator

mithro commented Apr 27, 2020

Verilog should publish documentation on ReadTheDocs like all good packages.

See https://docs.readthedocs.io/en/stable/ on how to get started.

The docs should be published at https://verible.readthedocs.io/
@mithro
Copy link
Collaborator Author

mithro commented Apr 27, 2020

@rw1nkler and @mgielda from @antmicro might also be able to give some tips and hints.
@daniellimws might also be interested in helping out here. He has been doing some great work for other SymbiFlow related projects.

@mithro
Copy link
Collaborator Author

mithro commented Apr 27, 2020

The idea at f4pga/ideas#49 could help with making this nice and easy.

@fangism fangism added the documentation Improvements or additions to documentation label Apr 27, 2020
@fangism
Copy link
Collaborator

fangism commented Apr 27, 2020

At this phase there isn't a formal API yet, nor any commitment to keep certain library interfaces stable. Current focus is on a few end-point tools.

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

No branches or pull requests
2 participants
@mithro @fangism