Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

setup docs with Mkdocs #218

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.

Sign up for GitHub

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

Jump to bottom
Merged
CunliangGeng merged 2 commits into from
Mar 5, 2024
Merged

setup docs with Mkdocs #218

CunliangGeng merged 2 commits into from
Mar 5, 2024

Conversation

@CunliangGeng
Copy link
Member

@CunliangGeng CunliangGeng commented Mar 5, 2024 •
edited
Loading

MkDocs is going to be used to build doc website. So that we can use markdown instead of rst to write tutorials and docs.

Major changes

  • Remove old setup of docs that depends on Sphinx
  • Add new setup of docs using MkDocs

This was referenced Mar 5, 2024
Merged
Merged
Merged
Merged
Merged
Merged
Merged
@CunliangGeng Graphite App
Copy link
Member Author

CunliangGeng commented Mar 5, 2024 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @CunliangGeng and the rest of your teammates on Graphite Graphite

@CunliangGeng CunliangGeng mentioned this pull request Mar 5, 2024
Merged
@CunliangGeng CunliangGeng self-assigned this Mar 5, 2024
@CunliangGeng CunliangGeng requested a review from gcroci2 March 5, 2024 11:17
@CunliangGeng CunliangGeng added the docs documentations label Mar 5, 2024
@CunliangGeng CunliangGeng mentioned this pull request Mar 5, 2024
Closed
5 tasks
gcroci2
gcroci2 approved these changes Mar 5, 2024
View reviewed changes
Copy link
Contributor

@gcroci2 gcroci2 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice template on the website! I just wonder, why Mkdocs instead of Sphinx? .md files can be used with Sphinx as well (see for example in deeprank2)

@CunliangGeng
Copy link
Member Author

CunliangGeng commented Mar 5, 2024

Yep, Sphinx can support markdown with the help of myst_parser. Markdown support is only a minor reason I choose mkdocs.
The major ones are that (1) I got tired of Sphnix after using it for years (2) Mkdocs has simpler setup and more fancy and modern looking (with the theme Material for MkDocs) than Sphinx :-)

@gcroci2 gcroci2 mentioned this pull request Mar 5, 2024
Closed
@CunliangGeng Graphite App
Copy link
Member Author

CunliangGeng commented Mar 5, 2024 •
edited
Loading

Merge activity

  • Mar 5, 10:38 AM EST: @CunliangGeng started a stack merge that includes this pull request via Graphite.
  • Mar 5, 10:44 AM EST: Graphite rebased this pull request as part of a merge.
  • Mar 5, 10:45 AM EST: @CunliangGeng merged this pull request with Graphite.

Base automatically changed from fix_docstrings to dev March 5, 2024 15:43
@CunliangGeng CunliangGeng merged commit d79b15c into dev Mar 5, 2024
@CunliangGeng CunliangGeng deleted the add_docs branch March 5, 2024 15:45
@CunliangGeng CunliangGeng mentioned this pull request Mar 6, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gcroci2 gcroci2 gcroci2 approved these changes

Assignees

@CunliangGeng CunliangGeng

Labels

docs documentations

Projects

dev
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@CunliangGeng @gcroci2
Morty Proxy This is a proxified and sanitized view of the page, visit original site.