Skip to content

docs: migrate document builder to mkdocs #665

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

Merged
merged 1 commit into from
Jun 2, 2023
Merged

docs: migrate document builder to mkdocs #665

merged 1 commit into from
Jun 2, 2023

Conversation

geniuspatrick
Copy link
Contributor

@geniuspatrick geniuspatrick commented May 30, 2023

Thank you for your contribution to the MindCV repo.
Before submitting this PR, please make sure:

Motivation

We are going to migrate our document builder for sphinx to mkdocs!

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Life is short, use mkdocs to write documents.

The structure of our documents is planned as follows:

  • Home
  • Installation
  • Model Zoo
  • Tutorials: # Learning Oriented
    • Quick Start
    • Configuration
    • etc.
  • How-To Guides: # Problem Oriented
    • Write A New Model
    • CLS/DET/SEG
    • etc.
  • Reference: The API Reference
  • Notes:
    • Change Log
    • Contributing
    • etc.

Test Plan

I added an action workflow to check if the document build was successful.

Related Issues and PRs

(Is this PR part of a group of changes? Link the other relevant PRs and Issues here. Use https://help.github.com/en/articles/closing-issues-using-keywords for help on GitHub syntax)

@geniuspatrick geniuspatrick changed the title docs: migrate to mkdocs docs: migrate document builder to mkdocs Jun 1, 2023
@geniuspatrick geniuspatrick merged commit 47e4d36 into mindspore-lab:main Jun 2, 2023
@geniuspatrick geniuspatrick deleted the docs branch June 2, 2023 01:58
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.

3 participants