You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Configuring mike to generate the documentation in the required format, such as HTML, PDF, etc.
Integrating mike with Github Actions, to automate the process of building and deploying the documentation.
Defining a versioning strategy for the documentation and updating it with every change in the code.
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.
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:
Configuring mike to generate the documentation in the required format, such as HTML, PDF, etc.
Integrating mike with Github Actions, to automate the process of building and deploying the documentation.
Defining a versioning strategy for the documentation and updating it with every change in the code.
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
The text was updated successfully, but these errors were encountered: