Project

General

Profile

Documentation #6465

admin/build-doc should have some kind of build check for broken links

Added by Dan Mick over 10 years ago. Updated about 4 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
-
Target version:
-
% Done:

0%

Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

See #6464. We should have something in the doc build process that complains
bitterly about broken links, and breaks the build.

History

#1 Updated by John Wilkins over 10 years ago

  • Assignee set to Alfredo Deza

#2 Updated by Alfredo Deza over 10 years ago

Maybe if we enabled the `-n` or 'nitpicky' option?

This could probably break the build, so we would need to check before implementing it:

http://sphinx-doc.org/config.html?highlight=nitpicky#confval-nitpicky

#3 Updated by Dan Mick over 10 years ago

Certainly easy to test, and yeah, I was thinking even some external thing like wget or curl or something. Whatever works.

#4 Updated by Dan Mick over 10 years ago

  • Priority changed from Normal to Urgent

Today in #ceph: (04:25:48 PM) angdraug: at http://ceph.com/docs/master/ the link to Ceph Block Device is broken: points at http://ceph.com/docs/master/rbd/ instead of .../master/rbd/rbd/

#5 Updated by Alfredo Deza about 10 years ago

  • Status changed from New to In Progress

I pushed some changes to a wip-6465 branch but it is failing with what looks like unrelated problems.

This is a link with one of the builds: http://gitbuilder.sepia.ceph.com/gitbuilder-doc/log.cgi?log=4390c28a798dade853bd5453955b9c2bba6e0ba7

Failure looks like:

 reading sources... [ 89%] radosgw/swift/tutorial
reading sources... [ 89%] radosgw/troubleshooting
reading sources... [ 90%] rbd/librbdpy
Traceback (most recent call last):
File "/tmp/virtualenv-docs/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 321, in import_object
__import__(self.modname)

    Error: Import No module named rbd 

#6 Updated by Alfredo Deza about 10 years ago

  • Assignee changed from Alfredo Deza to John Wilkins

No updates here, assigning back to John since this looks like a problem with the build.

The one change added to the wip-6465 branch is this:

0a6523b - (HEAD, origin/wip-6465, wip-6465) be nitpicky about missing references (8 weeks ago) <Alfredo Deza>
diff --git a/admin/build-doc b/admin/build-doc
index 634d580..deb56a3 100755
--- a/admin/build-doc
+++ b/admin/build-doc
@@ -50,7 +50,7 @@ $vdir/bin/pip install --quiet -r ../admin/doc-requirements.txt
 install -d -m0755 \
     output/html \
     output/man
-PYTHONPATH=`pwd`/../src/pybind $vdir/bin/sphinx-build -a -b dirhtml -d doctrees ../doc output/html
+PYTHONPATH=`pwd`/../src/pybind $vdir/bin/sphinx-build -a -n -b dirhtml -d doctrees ../doc output/html
 $vdir/bin/sphinx-build -a -b man -d doctrees ../doc output/man

 #

#7 Updated by Dan Mick about 10 years ago

John, do you need help resolving this? I really think that build checking buys us enough to warrant getting this working

#8 Updated by John Wilkins about 10 years ago

Actually, it seems like the :ref: syntax at least catches a file name mismatch. We should probably begin converting to that syntax.

#9 Updated by Dan Mick over 9 years ago

  • Priority changed from Urgent to Normal

No one else agrees this is urgent, so, dropping pri

#10 Updated by Zac Dover about 4 years ago

  • Status changed from In Progress to Closed

This bug has been judged too old to fix. This is because either it is either 1) raised against a version of Ceph prior to Luminous, or 2) just really old, and untouched for so long that it is unlikely nowadays to represent a live documentation concern.

If you think that the closing of this bug is an error, raise another bug of a similar kind. If you think that the matter requires urgent attention, please let Zac Dover know at .

Also available in: Atom PDF