Opened 8 years ago

Closed 8 years ago

#6940 task closed fixed (fixed)

Add all Twisted Names howto documents to the howto/index.rst toctree

Reported by: Richard Wall Owned by:
Priority: normal Milestone:
Component: names Keywords: documentation
Cc: Branch: branches/names-howto-toctree-6940
branch-diff, diff-cov, branch-cov, buildbot
Author: rwall

Description

The two new Twisted Names howto documents are missing a "Twisted Names" element in their breadcrumb navigation on readthdocs

Because I forgot to add links to those documents to the toctree in

  • source:trunk/docs/projects/names/howto/index.rst

Change History (4)

comment:1 Changed 8 years ago by Richard Wall

Author: rwall
Branch: branches/names-howto-toctree-6940

(In [41511]) Branching to 'names-howto-toctree-6940'

comment:2 Changed 8 years ago by Richard Wall

Keywords: review added

Ready for review in log:branches/names-howto-toctree-6940

  • It's not easy to see the effect of this in the locally rendered docs, since they don't seem to include an index or breadcrumb trail,
  • but you should notice that two toctree warnings have disappeared when the docs are build. Eg
cd docs
make html
...
checking consistency...
...
/home/richard/projects/Twisted/branches/names-howto-toctree-6940/docs/projects/names/howto/client-tour.rst:: WARNING: document isn't included in any toctree
/home/richard/projects/Twisted/branches/names-howto-toctree-6940/docs/projects/names/howto/custom-server.rst:: WARNING: document isn't included in any toctree
...
done

comment:3 Changed 8 years ago by Hynek Schlawack

Keywords: review removed

Please add an comment to #6905 so that this potential mistake is documented in the new style guide and merge.

comment:4 Changed 8 years ago by Richard Wall

Resolution: fixed
Status: newclosed

(In [41514]) Merge names-howto-toctree-6940

Author: rwall Reviewer: hynek Fixes: #6940

Add toctree links to twisted.names howto index.

Note: See TracTickets for help on using tickets.