Django

Code

Ticket #8724 (closed: fixed)

Opened 2 years ago

Last modified 1 year ago

Sphinx WARNINGS when using a SVN checkout

Reported by: richardb Assigned to: jacob
Milestone: 1.1 Component: Documentation
Version: SVN Keywords: Sphinx
Cc: Triage Stage: Accepted
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

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

8724.diff (0.5 kB) - added by richardb on 08/31/08 07:49:28.
patch to add exclude_dirnames

Change History

08/31/08 07:49:28 changed by richardb

  • attachment 8724.diff added.

patch to add exclude_dirnames

02/25/09 13:51:44 changed by

  • milestone deleted.

Milestone post-1.0 deleted

02/25/09 15:22:25 changed by jacob

  • status changed from new to assigned.
  • needs_better_patch changed.
  • needs_tests changed.
  • milestone set to 1.1.
  • owner changed from nobody to jacob.
  • needs_docs changed.
  • stage changed from Unreviewed to Accepted.

03/30/09 09:58:55 changed by kkubasik

This is going into the Kevin Kubasik Mega-Patch

04/03/09 13:30:55 changed by jacob

  • status changed from assigned to closed.
  • resolution set to fixed.

(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.

Add/Change #8724 (Sphinx WARNINGS when using a SVN checkout)




Change Properties
Action