Opened 4 years ago

Closed 4 years ago

#20095 closed enhancement (fixed)

Report broken links in the doc of graphs/

Reported by: ncohen Owned by:
Priority: major Milestone: sage-7.2
Component: documentation Keywords:
Cc: jmantysalo, kcrisman, jhpalmieri, dcoudert, vdelecroix Merged in:
Authors: Nathann Cohen Reviewers: David Coudert
Report Upstream: N/A Work issues:
Branch: 1c7bbbd (Commits) Commit: 1c7bbbd318fdeaa8c0282ffc8a065c2f37214116
Dependencies: Stopgaps:

Description

With this branch, no new broken link can appear in the documentation of the graph/ files. All currently broken links are also fixed.

Nathann

Change History (19)

comment:1 Changed 4 years ago by ncohen

  • Branch set to u/ncohen/20095
  • Commit set to 923353475724395c517c169b19af591b3e15ce3c
  • Status changed from new to needs_review

New commits:

9233534trac #20095: Report broken links in the doc of graphs/

comment:2 Changed 4 years ago by git

  • Commit changed from 923353475724395c517c169b19af591b3e15ce3c to 750bb872e7e302776c191ef9ccb271dba9b46b98

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

750bb87trac #20095: Report broken links in the doc of graphs/

comment:3 Changed 4 years ago by git

  • Commit changed from 750bb872e7e302776c191ef9ccb271dba9b46b98 to 0062a3214cb13903fbfcd9e4513973208a354a04

Branch pushed to git repo; I updated commit sha1. New commits:

0062a32trac #20095: unrelated typo

comment:4 Changed 4 years ago by dkrenn

Hmmm...`make doc-clean doc' gives

Traceback (most recent call last):
  File "/local/dakrenn/sage/7.1.beta4/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/cmdline.py", line 254, in main
    app.build(force_all, filenames)
  File "/local/dakrenn/sage/7.1.beta4/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/application.py", line 212, in build
    self.builder.build_update()
  File "/local/dakrenn/sage/7.1.beta4/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/builders/__init__.py", line 214, in build_update
    'out of date' % len(to_build))
  File "/local/dakrenn/sage/7.1.beta4/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/builders/__init__.py", line 276, in build
    self.write(docnames, list(updated_docnames), method)
  File "/local/dakrenn/sage/7.1.beta4/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/builders/__init__.py", line 320, in write
    self._write_serial(sorted(docnames), warnings)
  File "/local/dakrenn/sage/7.1.beta4/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/builders/__init__.py", line 331, in _write_serial
    doctree = self.env.get_and_resolve_doctree(docname, self)
  File "/local/dakrenn/sage/7.1.beta4/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/environment.py", line 1116, in get_and_resolve_doctree
    self.resolve_references(doctree, docname, builder)
  File "/local/dakrenn/sage/7.1.beta4/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/environment.py", line 1388, in resolve_references
    fromdocname, typ, target, node, domain)
  File "/local/dakrenn/sage/7.1.beta4/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/environment.py", line 1408, in _warn_missing_reference
    if domain.name == 'std' and (typ, target) in self._nitpick_ignore:
AttributeError: 'NoneType' object has no attribute 'name'
Version 0, edited 4 years ago by dkrenn (next)

comment:5 Changed 4 years ago by ncohen

Hmmmm... I had this message at some point and then is disappeared while I was working on the branch. Weird.

comment:6 Changed 4 years ago by ncohen

Seems reported and fixed in sphinx: https://github.com/sphinx-doc/sphinx/issues/1673

comment:7 Changed 4 years ago by ncohen

Sigh... Looks like the right way to go is to upgrade Sphinx (our version is ancient) as it is fixed in the latest version. Funny how I expect to end up with 999 others bugs to solve by trying that.

comment:8 Changed 4 years ago by ncohen

Almost found a way out. Except that Sphinx now complains that all links outside of graph/ are broken. I don't remember if there is a 'first phase' in Sphinx compilation, during which this nitpicky mode should be disabled... What a waste of time. 1 hour....

comment:9 Changed 4 years ago by ncohen

1 hour and a half. Seems impossible because of our f****** 2-pass doc building hack.

comment:10 Changed 4 years ago by ncohen

  • Milestone changed from sage-7.1 to sage-duplicate/invalid/wontfix
  • Status changed from needs_review to positive_review

Okay, let it go to hell. I'm sick and tired of trying to figure out other people's hacks.

Nathann

Last edited 4 years ago by ncohen (previous) (diff)

comment:11 Changed 4 years ago by git

  • Commit changed from 0062a3214cb13903fbfcd9e4513973208a354a04 to 1d657f62e7e0501a2e65b3dd328d343d150fe0d5
  • Status changed from positive_review to needs_review

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. New commits:

1d657f6wasted time

comment:12 Changed 4 years ago by jmantysalo

I don't understand. If there are bugs in Sphinx and you made a code that would work without those bugs, shouldn't this be put on wishlist-queue to wait for Sphinx?

comment:13 follow-up: Changed 4 years ago by ncohen

Jori: I don't care anymore. Do whatever you want with this ticket.

comment:14 in reply to: ↑ 13 Changed 4 years ago by jmantysalo

  • Milestone changed from sage-duplicate/invalid/wontfix to sage-wishlist

Replying to ncohen:

Jori: I don't care anymore. Do whatever you want with this ticket.

Take a break? Decide that you don't touch Sage development until 2016-03-22.

comment:15 Changed 4 years ago by jmantysalo

  • Branch changed from u/ncohen/20095 to u/jmantysalo/20095

comment:16 Changed 4 years ago by jmantysalo

  • Commit changed from 1d657f62e7e0501a2e65b3dd328d343d150fe0d5 to 1c7bbbd318fdeaa8c0282ffc8a065c2f37214116
  • Component changed from graph theory to documentation
  • Milestone changed from sage-wishlist to sage-7.2
  • Status changed from needs_review to needs_work

Something should be done to automatically forbid broken links, or at least to found them easily.

However, I suggest that in this patch we correct those in graphs-directory, and talk more general question at sage-devel. I did that modification.

But I am now compiling and testing, so this is not ready for review yet.


New commits:

1c7bbbdRemoved 'general' part, leaved link corrections.

comment:17 Changed 4 years ago by jmantysalo

  • Status changed from needs_work to needs_review

Tests passed.

comment:18 Changed 4 years ago by dcoudert

  • Reviewers set to David Coudert
  • Status changed from needs_review to positive_review

I fully agree with what you did. For me the patch is good to go (passes tests, fix broken links, etc.). David.

comment:19 Changed 4 years ago by vbraun

  • Branch changed from u/jmantysalo/20095 to 1c7bbbd318fdeaa8c0282ffc8a065c2f37214116
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.