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

Auto-documentation support added #357

Merged
merged 7 commits into from
May 31, 2022
Merged

Auto-documentation support added #357

merged 7 commits into from
May 31, 2022

Conversation

abiswal2001
Copy link
Collaborator

To generate the html files, run make html in the docs directory. This generates html files in the _build subfolder using documentation autogenerated from docstrings.

Copy link
Contributor

@parasj parasj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we integrate this with the github action? You can test it on your PR by commenting out the main branch check in the workflow yaml.

docs/modules.rst Outdated Show resolved Hide resolved
docs/modules.rst Outdated Show resolved Hide resolved
docs/skylark.rst Outdated Show resolved Hide resolved
@parasj parasj merged commit 41432b2 into main May 31, 2022
@parasj parasj deleted the dev/asim/documentation branch May 31, 2022 22:46
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

Successfully merging this pull request may close these issues.

2 participants