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

Automatically sort documented members by source order #88

Merged
merged 2 commits into from
Apr 8, 2021

Conversation

peizhenbai
Copy link
Collaborator

Description

Change doc config file and modify the default sorted method from alphabetical to source order.

Status

Ready

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • In-line docstrings updated and documentation docs updated.

@codecov-io
Copy link

codecov-io commented Apr 8, 2021

Codecov Report

Merging #88 (60be7bb) into master (7fd32df) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master     #88   +/-   ##
======================================
  Coverage    4.44%   4.44%           
======================================
  Files          36      36           
  Lines        2927    2927           
======================================
  Hits          130     130           
  Misses       2797    2797           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7fd32df...60be7bb. Read the comment docs.

@peizhenbai
Copy link
Collaborator Author

@haipinglu I find a new solution to automatically sort doc members by sorce order and do not need to modify rst files one by one. The Sphinx supports change default sort method by setting in conf file. Test on local and work well.

@haipinglu haipinglu merged commit 0fe9258 into master Apr 8, 2021
@haipinglu haipinglu deleted the doc-update branch April 8, 2021 11:13
This was referenced Apr 18, 2021
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