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

#179 Migrate API docs with MkDocs #189

Merged
merged 6 commits into from
Nov 3, 2023

Conversation

fktn-k
Copy link
Owner

@fktn-k fktn-k commented Nov 3, 2023

API documentations have been moved to the docs/mkdocs/api directory to serve the documentation with MkDocs.
For development, doxygen style comments are left in the source files.

@fktn-k fktn-k changed the title #179 Migrate API docs with mkdocs #179 Migrate API docs with MkDocs Nov 3, 2023
@coveralls
Copy link

coveralls commented Nov 3, 2023

Coverage Status

coverage: 100.0%. remained the same
when pulling d6eb3b0 on feature/179_migrate_api_docs_with_mkdocs
into 5cf5bfc on develop.

@fktn-k fktn-k self-assigned this Nov 3, 2023
@fktn-k fktn-k added the documentation Improvements or additions to documentation label Nov 3, 2023
@fktn-k fktn-k added this to the Release v0.2.0 milestone Nov 3, 2023
@fktn-k fktn-k merged commit 8315644 into develop Nov 3, 2023
104 checks passed
@fktn-k fktn-k deleted the feature/179_migrate_api_docs_with_mkdocs branch November 3, 2023 20:51
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

Successfully merging this pull request may close these issues.

None yet

2 participants