Project

Profile

Help

Task #8790

Enable Sphinx nitpick mode with -n

Added by bmbouter 5 months ago. Updated 5 months ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Quarter:

Description

Sphinx has a nitpick mode: https://www.sphinx-doc.org/en/master/man/sphinx-build.html

You could enable it here: https://github.com/pulp/pulpcore/blob/master/docs/Makefile#L5

If you do, you'll get this error:

Warning, treated as error:
../CHANGES.rst:1488:py:meth reference target not found: pulpcore.content.handler.Handler.list_directory
make: *** [Makefile:58: html] Error 2

Please register to edit this issue

Also available in: Atom PDF