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

Proposal: Add IndexDomain for database of general indices #6543

Merged
merged 1 commit into from Dec 22, 2019

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Jun 30, 2019

Feature or Bugfix

  • Refactoring

Purpose

  • So far, we've stored general index entries to env.indexentries.
  • This moves them all to new IndexDomain.
  • adapter and collector for indexentries will be also replaced (in later step).

@tk0miya tk0miya added this to the 2.2.0 milestone Jun 30, 2019
@tk0miya tk0miya force-pushed the refactor_indexentries branch 2 times, most recently from 3cae166 to ae8b993 Compare July 6, 2019 05:18
@codecov
Copy link

codecov bot commented Jul 6, 2019

Codecov Report

❗ No coverage uploaded for pull request base (2.0@cf50ec3). Click here to learn what that means.
The diff coverage is 86.66%.

Impacted file tree graph

@@          Coverage Diff           @@
##             2.0    #6543   +/-   ##
======================================
  Coverage       ?   83.69%           
======================================
  Files          ?      269           
  Lines          ?    40897           
  Branches       ?     5988           
======================================
  Hits           ?    34227           
  Misses         ?     5344           
  Partials       ?     1326
Impacted Files Coverage Δ
tests/test_build_html.py 97.61% <ø> (ø)
sphinx/application.py 78.29% <ø> (ø)
sphinx/environment/collectors/indexentries.py 0% <0%> (ø)
sphinx/environment/__init__.py 77.66% <100%> (ø)
sphinx/domains/index.py 94.11% <94.11%> (ø)

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 cf50ec3...6d6fe9d. Read the comment docs.

@tk0miya tk0miya modified the milestones: 2.2.0, 2.3.0 Aug 18, 2019
@tk0miya tk0miya modified the milestones: 2.3.0, 2.4.0 Dec 8, 2019
@shimizukawa
Copy link
Member

A domain is a collection of markup (reStructuredText directives and roles) to describe and link to objects belonging together, e.g. elements of a programming language.
http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html

I thought "domain" is a set of directives and roles for each language, but "language" is just one use case.
Now I accept IndexDomain.

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

@tk0miya tk0miya added the domain label Dec 22, 2019
@tk0miya tk0miya merged commit 26cd301 into sphinx-doc:2.0 Dec 22, 2019
@tk0miya
Copy link
Member Author

tk0miya commented Dec 22, 2019

Merged. Thank you for reviewing!

@tk0miya tk0miya deleted the refactor_indexentries branch December 22, 2019 08:27
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants