Opened 5 years ago

Closed 5 years ago

#21418 closed defect (fixed)

fix references in coding/

Reported by: dimpase Owned by:
Priority: major Milestone: sage-7.4
Component: documentation Keywords:
Cc: dlucas, jsrn Merged in:
Authors: Dima Pasechnik Reviewers: Johan Rosenkilde
Report Upstream: N/A Work issues:
Branch: 0425188 (Commits, GitHub, GitLab) Commit: 04251884402089a280e6f92400f34bbfc579a816
Dependencies: Stopgaps:

Status badges

Description

currently there are multiply defined references, missing '_', etc. Here we fix this.

Change History (12)

comment:1 Changed 5 years ago by dimpase

  • Branch set to u/dimpase/codedocs
  • Cc dlucas jsrn added
  • Commit set to 6a38b4a3a76234b7d20e875a40dde465ea2501a4
  • Status changed from new to needs_review

New commits:

6a38b4afixed broken refs

comment:2 Changed 5 years ago by jsrn

In the html compiled doc of sage.coding.hamming_code, the [HP] doesn't show up as a link for me. Shouldn't it?

EDIT: Many other links are also not hyperlinked, maybe all occurrences where the def is not in the same file, at least uses of [HP] and [BH12].

Last edited 5 years ago by jsrn (previous) (diff)

comment:3 Changed 5 years ago by jsrn

The incomplete reference [Feu2009] that you deleted, should probably be this:

... [Feu2009] Thomas Feulner, The Automorphism Groups of Linear Codes and Canonical Representatives of Their Semilinear Isometry Classes, Advances in Mathematics of Communications 3 (4), pp. 363-383, 2009

comment:4 Changed 5 years ago by dimpase

yep, more fixes are coming, sorry.

comment:5 Changed 5 years ago by jsrn

  • Status changed from needs_review to needs_work

comment:6 Changed 5 years ago by jsrn

Incremental building fails for me: after a successful make doc-clean && make, I make a trivial change in sage/coding/hamming_code.py followed by make. Then [HP] cross-referencing breaks:

...
[dochtml] [coding   ] writing output... [100%] sage/coding/hamming_code
[dochtml] [coding   ] /home/jsrn/mat/sage_coding_project/local/lib/python2.7/site-packages/sage/coding/hamming_code.py:docstring of sage.coding.hamming_code.HammingCode.parity_check_matrix:8: WARNING: citation not found: HP
[dochtml] Error building the documentation.
[dochtml] Traceback (most recent call last):
[dochtml]   File "/home/jsrn/mat/sage_coding_project/local/lib/python/runpy.py", line 162, in _run_module_as_main
[dochtml]     "__main__", fname, loader, pkg_name)
[dochtml]   File "/home/jsrn/mat/sage_coding_project/local/lib/python/runpy.py", line 72, in _run_code
[dochtml]     exec code in run_globals
[dochtml]   File "/home/jsrn/mat/sage_coding_project/local/lib/python2.7/site-packages/sage_setup/docbuild/__main__.py", line 2, in <module>
[dochtml]     main()
[dochtml]   File "/home/jsrn/mat/sage_coding_project/local/lib/python2.7/site-packages/sage_setup/docbuild/__init__.py", line 1630, in main
[dochtml]     builder()
[dochtml]   File "/home/jsrn/mat/sage_coding_project/local/lib/python2.7/site-packages/sage_setup/docbuild/__init__.py", line 288, in _wrapper
[dochtml]     getattr(get_builder(document), name)(*args, **kwds)
[dochtml]   File "/home/jsrn/mat/sage_coding_project/local/lib/python2.7/site-packages/sage_setup/docbuild/__init__.py", line 495, in _wrapper
[dochtml]     x.get(99999)
[dochtml]   File "/home/jsrn/mat/sage_coding_project/local/lib/python/multiprocessing/pool.py", line 567, in get
[dochtml]     raise self._value
[dochtml] OSError: [coding   ] /home/jsrn/mat/sage_coding_project/local/lib/python2.7/site-packages/sage/coding/hamming_code.py:docstring of sage.coding.hamming_code.HammingCode.parity_check_matrix:8: WARNING: citation not found: HP
...

comment:7 Changed 5 years ago by git

  • Commit changed from 6a38b4a3a76234b7d20e875a40dde465ea2501a4 to 04251884402089a280e6f92400f34bbfc579a816

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

0425188replacing - by .. and more reformatting and cleanup

comment:8 Changed 5 years ago by dimpase

  • Status changed from needs_work to needs_review

this hopefully fixes it all now. I initially forgot to replace some '-' by '..'.

comment:9 follow-up: Changed 5 years ago by jsrn

Indeed, it seems to work now. I'll give positive_review as soon as my make doc-clean && make finishes without issue.

I just don't get Sphinx: apparently the errors I saw (missing hyperlink + error in incremental build) was because of the non-ReST citation [HP] in linear_code.py? Great error then: WARNING: citation not found: HP...

comment:10 Changed 5 years ago by jsrn

  • Reviewers set to Johan Rosenkilde
  • Status changed from needs_review to positive_review

comment:11 in reply to: ↑ 9 Changed 5 years ago by dimpase

Replying to jsrn:

Indeed, it seems to work now. I'll give positive_review as soon as my make doc-clean && make finishes without issue.

I just don't get Sphinx: apparently the errors I saw (missing hyperlink + error in incremental build) was because of the non-ReST citation [HP] in linear_code.py? Great error then: WARNING: citation not found: HP...

IMHO it was because in the first branch I removed .. [HP] in one file and left - [HP] in another, without replacing it by .. [HP] . No wonder incremental build did not work.

comment:12 Changed 5 years ago by vbraun

  • Branch changed from u/dimpase/codedocs to 04251884402089a280e6f92400f34bbfc579a816
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.