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

Adding auto-generated page to toctree #3376

Closed
bomb-on opened this issue Jan 31, 2017 · 1 comment
Closed

Adding auto-generated page to toctree #3376

bomb-on opened this issue Jan 31, 2017 · 1 comment

Comments

@bomb-on
Copy link

bomb-on commented Jan 31, 2017

Subject: Adding auto-generated page to toctree

Problem

I tried to put a link to the 'routing table' page generated by sphinxcontrib.httpdomain extension into my toctree:

.. toctree::
   :maxdepth: 3
   :hidden:

   Introduction <docs/intro>
   :ref:`Complete Reference <routingtable>`
   Changelog <docs/changelog>

but I got an error:

WARNING: toctree contains reference to nonexisting document u':ref:` <routingtable>`'

Is it possible to somehow link the routing table page in my toctree?

Procedure to reproduce the problem

  • Install the extension
    pip install sphinxcontrib-httpdomain

  • Update config.py

from sphinx.domains.std import StandardDomain

extensions.append('sphinxcontrib.httpdomain')

def setup(app):
    StandardDomain.initial_data['labels']['routingtable'] = (
        'http-routingtable',
        '',
        'HTTP Routing Table')
    StandardDomain.initial_data['anonlabels']['routingtable'] = (
        'http-routingtable',
        '')
"""
  • Add to index.rst file
Documentation
=============

.. toctree::
   :maxdepth: 3
   :hidden:

   Introduction <docs/intro>
   :ref:`Complete Reference <routingtable>`
   Changelog <docs/changelog>
  • Build docs
    make html

  • Visit generated TOC page in your build.

Error logs / results

WARNING: toctree contains reference to nonexisting document u':ref:` <routingtable>`'

Expected results

I'd like to include generated page into my toctree.

Environment info

  • OS: AWS Linux and Mac OS X
  • Python version: 3.4
  • Sphinx version: 1.5.2
  • sphinxcontrib.httpdomain version: 1.5.0
@tk0miya
Copy link
Member

tk0miya commented Jan 31, 2017

Thank you for proposal.
We'll consider the feature in #2354 and #1800.

Thanks,

@tk0miya tk0miya closed this as completed Jan 31, 2017
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants