Skip to content

Enhance the documentation. #374

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
merged 17 commits into from
Jun 30, 2021
Merged

Enhance the documentation. #374

merged 17 commits into from
Jun 30, 2021

Conversation

ganler
Copy link
Contributor

@ganler ganler commented Jun 30, 2021 •
edited
Loading

  1. Refine's Yixiao's wording and broken markdown codes;
  2. Leverage a more good-looking template, i.e., https://sphinx-themes.org/sample-sites/furo/
  3. Leverage MyST as a better documentation language https://myst-parser.readthedocs.io/en/latest/sphinx/intro.html

Would love to have feedbacks and inputs from @Gyx-One @luomai @zsdonghao

@ganler
Copy link
Contributor Author

ganler commented Jun 30, 2021

@Gyx-One Our Python API still has a lot of ill-formed docstring. I hope you can resolve these issues (remember to debug the doc locally).

image

@ganler
Copy link
Contributor Author

ganler commented Jun 30, 2021

To debug the documents:

cd docs
pip install -r requirements.txt
make html

Open docs/_build/index.html. cc @Gyx-One

@ganler
Copy link
Contributor Author

ganler commented Jun 30, 2021

I believe now it looks better...

image

@ganler
Copy link
Contributor Author

ganler commented Jun 30, 2021 •
edited
Loading

Progress:

  • installation
  • quick-start
  • performance
  • design
  • Python Docstring @Gyx-One

luomai
luomai reviewed Jun 30, 2021
View reviewed changes
@ganler
Copy link
Contributor Author

ganler commented Jun 30, 2021

Very helpful suggestions! Thanks, Luo. @luomai

@ganler
Copy link
Contributor Author

ganler commented Jun 30, 2021

Progress:

  • installation
  • quick-start
  • performance
  • design
  • Python Docstring @Gyx-One

Let's put the left three in another PR.

@Gyx-One
Copy link
Contributor

Gyx-One commented Jun 30, 2021

Nice job! :)
I'll fix Python DocString in two days

@ganler ganler changed the title [WIP] Enhance the documentation. Enhance the documentation. Jun 30, 2021
@ganler ganler merged commit a90d286 into master Jun 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@luomai luomai luomai left review comments

@Gyx-One Gyx-One Gyx-One approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ganler @Gyx-One @luomai