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.

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

Fix #5362: apidoc: Add --toc option to change the filename of ToC #5375

Merged
merged 1 commit into from
Sep 6, 2018
Merged

Fix #5362: apidoc: Add --toc option to change the filename of ToC #5375

merged 1 commit into from
Sep 6, 2018

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Sep 2, 2018

Feature or Bugfix

  • Feature
  • Bugfix

Purpose

@tk0miya tk0miya added this to the 1.8.0 milestone Sep 2, 2018
@codecov
Copy link

codecov bot commented Sep 2, 2018 •
edited
Loading

Codecov Report

Merging #5375 into 1.8 will increase coverage by <.01%.
The diff coverage is 50%.

Impacted file tree graph

@@            Coverage Diff            @@
##              1.8   #5375      +/-   ##
=========================================
+ Coverage   82.09%   82.1%   +<.01%     
=========================================
  Files         303     297       -6     
  Lines       40266   39929     -337     
  Branches     6223    6169      -54     
=========================================
- Hits        33058   32783     -275     
+ Misses       5832    5776      -56     
+ Partials     1376    1370       -6
Impacted Files Coverage Δ
sphinx/ext/apidoc.py 76.62% <50%> (+0.1%) ⬆️
sphinx/builders/html.py 82.83% <0%> (-0.1%) ⬇️
sphinx/make_mode.py
sphinx/search/__init__.py
sphinx/quickstart.py
sphinx/errors.py
sphinx/__init__.py
sphinx/apidoc.py

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 4abc552...86abb57. Read the comment docs.

tk0miya
tk0miya commented Sep 5, 2018
View reviewed changes
doc/man/sphinx-apidoc.rst Outdated
@@ -58,6 +58,10 @@ Options

Maximum depth for the generated table of contents file.

.. option:: --toc
Copy link
Member Author

Choose a reason for hiding this comment

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

@shimizukawa which would you like --toc or --tocfile?

Copy link
Member

Choose a reason for hiding this comment

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

--tocfile is better to me.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you for comment. done.

shimizukawa
shimizukawa approved these changes Sep 5, 2018
View reviewed changes
Copy link
Member

@shimizukawa shimizukawa left a comment

Choose a reason for hiding this comment

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

LGTM with a comment.

@tk0miya tk0miya merged commit dfbf90a into sphinx-doc:1.8 Sep 6, 2018
@tk0miya tk0miya deleted the 5362_apidoc_toc branch September 6, 2018 12:33
@tk0miya
Copy link
Member Author

tk0miya commented Sep 6, 2018

Merged. Thank you for reviewing.

@tk0miya tk0miya mentioned this pull request Sep 6, 2018
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shimizukawa shimizukawa shimizukawa approved these changes

Assignees
No one assigned
Labels
extensions:apidoc type:bug type:proposal a feature suggestion
Projects
None yet
Milestone
1.8.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@tk0miya @shimizukawa