Opened at 2020-11-25T03:44:50Z

Closed at 2021-01-26T00:06:55Z

#3536 closed defect (fixed)

Warnings when building documentation

Reported by: sajith Owned by: sajith
Priority: normal Milestone: undecided
Component: documentation Version: n/a
Keywords: Cc:
Launchpad Bug:

Description (last modified by sajith)

There are some warnings about files that are outside doc directory: 

$ cd doc; make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v2.4.3
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 4 source files that are out of date
updating environment: 1 added, 4 changed, 0 removed
reading sources... [100%] windows                                                                                                                                                                                                                                                                                             
tahoe-lafs/docs/index.rst:10: WARNING: toctree contains reference to nonexisting document '.github/CONTRIBUTING'
tahoe-lafs/docs/index.rst:10: WARNING: toctree contains reference to nonexisting document 'CODE_OF_CONDUCT'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] windows                                                                                                                                                                                                                                                                                              
generating indices...  genindexdone
writing additional pages...  searchdone
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 2 warnings.

The HTML pages are in _build/html.

Build finished. The HTML pages are in _build/html.

Change History (4)

comment:1 Changed at 2020-11-25T03:45:43Z by sajith

  • Description modified (diff)

comment:2 Changed at 2021-01-05T01:29:14Z by sajith

There's a new warning now: 

tahoe-lafs/docs/release-checklist.rst: WARNING: document isn't included in any toctree

comment:3 Changed at 2021-01-05T02:07:56Z by sajith

Current warnings: 

tahoe-lafs/docs/frontends/webapi.rst:2035: WARNING: Unexpected indentation.
tahoe-lafs/docs/index.rst:10: WARNING: toctree contains reference to nonexisting document u'.github/CONTRIBUTING'
tahoe-lafs/docs/index.rst:10: WARNING: toctree contains reference to nonexisting document u'CODE_OF_CONDUCT'
tahoe-lafs/docs/release-checklist.rst:49: WARNING: Unexpected indentation.
tahoe-lafs/docs/release-checklist.rst:50: WARNING: Block quote ends without a blank line; unexpected unindent.
tahoe-lafs/docs/release-checklist.rst:89: WARNING: Unexpected indentation.
tahoe-lafs/docs/release-checklist.rst:90: WARNING: Block quote ends without a blank line; unexpected unindent.
tahoe-lafs/docs/release-checklist.rst:140: WARNING: Inline emphasis start-string without end-string.
tahoe-lafs/docs/release-checklist.rst: WARNING: document isn't included in any toctree

comment:4 Changed at 2021-01-26T00:06:55Z by GitHub <noreply@…>

  • Resolution set to fixed
  • Status changed from new to closed

In c22cf50/trunk:

Merge pull request #954 from tahoe-lafs/3536.sphinx-warnings

Fix some Sphinx warnings

Fixes: ticket:3536

Note: See TracTickets for help on using tickets.