Skip to content

upgrade to sphinx 1.1 #60675

Closed
Closed

Description

@cjerdonek
BPO 16471
Nosy @birkenfeld, @terryjreedy, @vstinner, @ezio-melotti, @merwok, @cjerdonek
Superseder
  • bpo-10224: Build 3.x documentation using python3.x
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
    closed_at = <Date 2013-03-15.01:10:23.564>
    created_at = <Date 2012-11-14.10:27:50.027>
    labels = ['type-feature', 'docs']
    title = 'upgrade to sphinx 1.1'
    updated_at = <Date 2013-03-15.01:10:23.563>
    user = 'https://github.com/cjerdonek'

    bugs.python.org fields:

    activity = <Date 2013-03-15.01:10:23.563>
    actor = 'terry.reedy'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2013-03-15.01:10:23.564>
    closer = 'terry.reedy'
    components = ['Documentation']
    creation = <Date 2012-11-14.10:27:50.027>
    creator = 'chris.jerdonek'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 16471
    keywords = []
    message_count = 4.0
    messages = ['175560', '175717', '184198', '184208']
    nosy_count = 7.0
    nosy_names = ['georg.brandl', 'terry.reedy', 'vstinner', 'ezio.melotti', 'eric.araujo', 'chris.jerdonek', 'docs@python']
    pr_nums = []
    priority = 'normal'
    resolution = 'duplicate'
    stage = 'needs patch'
    status = 'closed'
    superseder = '10224'
    type = 'enhancement'
    url = 'https://bugs.python.org/issue16471'
    versions = []

    Activity

    1. cjerdonek commented on Nov 14, 2012

      @cjerdonek
      MemberAuthor

      This issue is to upgrade Python's Sphinx from version 1.0 to 1.1.

      I don't already see an issue for this, and I'm not sure what upgrading entails.

      Personally, I'm interested in the enhanced indexing capabilities, e.g. the "see" and "seealso" entry types, as well as marking main index entries:

      http://sphinx-doc.org/markup/misc.html#directive-index

      I'm sure other reasons for upgrading have been floated, though I don't know what they are.

    2. added
      docsDocumentation in the Doc dir
      type-featureA feature request or enhancement
      on Nov 14, 2012
    3. vstinner commented on Nov 16, 2012

      @vstinner
      Member

      According to the changelog, Sphinx 1.1 now supports Python 3. Cool!

      Doc/Makefile may be modified to use "PYTHON = python3".

    4. ezio-melotti commented on Mar 14, 2013

      @ezio-melotti
      Member

      When this is done make.bat should be updated too.

    5. terryjreedy commented on Mar 15, 2013

      @terryjreedy
      Member

      This duplicates a part of bpo-10224, which proposes to upgrade all of Sphinx, Jinja2, and Pygments to Python 3 compatible versions (so we can build docs with Py3). In msg175768, Brett claims that all three have such versions.

      Chris, if you want to push to only upgrade Sphinx and not the other two, you can re-open. But I'd like to see a justification as I suspect that upgrading the other two will, if anything, be easier (assuming no breakage of current usage).

    6. transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      docsDocumentation in the Doc dirtype-featureA feature request or enhancement

      Projects

      No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions