Opened 13 years ago

Closed 13 years ago

#7750 closed enhancement (fixed)

search_doc: print warning if some Sage docs are missing

Reported by: jhpalmieri Owned by: mvngu
Priority: minor Milestone:
Component: documentation Keywords:
Cc: Merged in: sage-4.3.1.alpha0
Authors: John Palmieri Reviewers: William Stein
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

If you call search_doc and one piece of the Sage docs are missing, this patch prints the following warning (and then proceeds with the search):

sage: search_doc('factorial')
Warning, the following Sage documentation hasn't been built,
so documentation search results may be incomplete:

/Applications/sage/devel/sage/doc/output/html/fr/tutorial

You can build this with 'sage -docbuild fr/tutorial html'.

If more than one piece is missing, it prints this warning:

sage: search_doc('factorial')
Warning, the following Sage documentation hasn't been built,
so documentation search results may be incomplete:

/Applications/sage/devel/sage/doc/output/html/en/developer
/Applications/sage/devel/sage/doc/output/html/en/installation
/Applications/sage/devel/sage/doc/output/html/fr/tutorial

You can build these with 'sage -docbuild DOCUMENT html',
where DOCUMENT is one of 'developer', 'installation', 'fr/tutorial', 
or you can use 'sage -docbuild all html' to build all of the missing documentation.

You can test this by installing the patch and selectively deleting and building pieces of the documentation. You don't need to restart Sage between deletions or builds -- do that in another window, and each call to search_doc will check for existence of the docs each time.

There are no doctests for this, because I think that doctests should assume that the Sage build is complete: all documentation should be assumed to be built.

Attachments (1)

trac_7750-search-doc.patch (4.4 KB) - added by jhpalmieri 13 years ago.

Download all attachments as: .zip

Change History (4)

comment:1 Changed 13 years ago by jhpalmieri

  • Status changed from new to needs_review

Changed 13 years ago by jhpalmieri

comment:2 Changed 13 years ago by was

  • Status changed from needs_review to positive_review

This is *awesome*. Positive review.

comment:3 Changed 13 years ago by mhansen

  • Merged in set to sage-4.3.1.alpha0
  • Resolution set to fixed
  • Reviewers set to William Stein
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.