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

Make documentation version-able using mike #20

Closed
smileisak opened this issue Jan 30, 2023 · 0 comments · Fixed by #29
Closed

Make documentation version-able using mike #20

smileisak opened this issue Jan 30, 2023 · 0 comments · Fixed by #29
Labels
documentation Improvements or additions to documentation

Comments

@smileisak
Copy link
Member

smileisak commented Jan 30, 2023

The objective of this task is to make the Nauticus documentation version-able using mike. Mike is a Python utility that helps in deploying multiple versions of documentation to a Git branch, which can be hosted on Github via gh-pages.

The following steps are involved in this process:

  1. Configuring mike to generate the documentation in the required format, such as HTML, PDF, etc.

  2. Integrating mike with Github Actions, to automate the process of building and deploying the documentation.

  3. Defining a versioning strategy for the documentation and updating it with every change in the code.

  4. Updating the README file of the repository with a link to the versioned documentation.

By the end of this task, the Nauticus documentation will be version-able and easily accessible for all stakeholders, helping them stay updated with the latest changes in the code.

Reference

https://github.com/jimporter/mike

@smileisak smileisak added the documentation Improvements or additions to documentation label Jan 30, 2023
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 a pull request may close this issue.

1 participant