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

HTML version of API documentation (docstrings) #6

Merged
merged 3 commits into from
Oct 31, 2024
Merged

Conversation

yomichi
Copy link
Contributor

@yomichi yomichi commented Oct 31, 2024

A sample is available at
https://issp-center-dev.github.io/ODAT-SE/manual/deploy_api_docs/api/index.html

After merged into the main branch, the latest version of API references will be uploaded to

The API reference manual of the main branch is automatically deployed at
https://issp-center-dev.github.io/ODAT-SE/manual/main/api/index.html

To make all the documents including the API reference, run the make.sh script in the doc/ directory.

@yomichi yomichi merged commit 9dd6991 into main Oct 31, 2024
30 checks passed
@yomichi
Copy link
Contributor Author

yomichi commented Oct 31, 2024

I changed the sphinx theme of the API reference manual from haiku to sphinx_rtd_theme for visibility

@yomichi yomichi deleted the deploy_api_docs branch October 31, 2024 04:29
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.

1 participant