Opened 8 years ago

Closed 8 years ago

Last modified 5 years ago

#8724 closed (fixed)

Sphinx WARNINGS when using a SVN checkout

Reported by: Richard Barran Owned by: Jacob
Component: Documentation Version: master
Severity: Keywords: Sphinx
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Scenario: a copy of Django checked from SVN, use Sphinx to build the documentation. We get 32 warning messages because Sphinx reads in the .svn folders, example:

WARNING: /Users/richard/TechyStuff/Django1.0-SVN/docs/_build/.svn/README.txt:: document isn't included in any toctree

This patch adds a Sphinx configuration option to ignore .svn folders.

Note: this option is new to Sphinx 0.5, maybe the doc build process should also be changed to check for correct version of Sphinx?

Attachments (1)

8724.diff (527 bytes) - added by Richard Barran 8 years ago.
patch to add exclude_dirnames

Download all attachments as: .zip

Change History (6)

Changed 8 years ago by Richard Barran

Attachment: 8724.diff added

patch to add exclude_dirnames

comment:1 Changed 8 years ago by (none)

milestone: post-1.0

Milestone post-1.0 deleted

comment:2 Changed 8 years ago by Jacob

milestone: 1.1
Owner: changed from nobody to Jacob
Status: newassigned
Triage Stage: UnreviewedAccepted

comment:3 Changed 8 years ago by Kevin Kubasik

This is going into the Kevin Kubasik Mega-Patch

comment:4 Changed 8 years ago by Jacob

Resolution: fixed
Status: assignedclosed

(In [10371]) Fixed a whole bunch of small docs typos, errors, and ommissions.

Fixes #8358, #8396, #8724, #9043, #9128, #9247, #9267, #9267, #9375, #9409, #9414, #9416, #9446, #9454, #9464, #9503, #9518, #9533, #9657, #9658, #9683, #9733, #9771, #9835, #9836, #9837, #9897, #9906, #9912, #9945, #9986, #9992, #10055, #10084, #10091, #10145, #10245, #10257, #10309, #10358, #10359, #10424, #10426, #10508, #10531, #10551, #10635, #10637, #10656, #10658, #10690, #10699, #19528.

Thanks to all the respective authors of those tickets.

comment:18 Changed 5 years ago by Jacob

milestone: 1.1

Milestone 1.1 deleted

Note: See TracTickets for help on using tickets.
Back to Top