aboutsummaryrefslogtreecommitdiff
path: root/doc/build.scm
Commit message (Collapse)AuthorAge
* doc: Clarify further the distinction between the web-based manuals.Leo Famulari2021-04-20
| | | | | | | | | | As discussed on #guix IRC, several of us struggle to reliably choose the right option based on the old labels: https://logs.guix.gnu.org/guix/2021-04-20.log#182137 * doc/build.scm (html-manual-indexes): Try to distinguish between the two options more clearly.
* doc: Build the French HTML cookbook.Julien Lepiller2021-04-18
| | | | * doc/build.scm (%languages): Add 'fr' cookbook translation.
* doc: Remove the guile-lib/htmlprag-fixed package.Maxim Cournoyer2021-03-20
| | | | | | | | | | This hotfix package is no longer necessary as the ability to parameterize the way htmlprag tokenizes HTML was added in guile-lib 0.2.7. * doc/build.scm (guile-lib/htmlprag-fixed): Remove variable. (html-manual-identifier-index): Replace guile-lib/htmlprag-fixed by guile-lib, and make set the %strict-tokenizer? parameter to #t. (syntax-highlighted-html): Likewise.
* doc: Cookbook links to /manual/devel, not /manual.Ludovic Courtès2020-10-21
| | | | | | | | Since the Cookbook is built from the 'master' branch, it should point to the manual from that same branch. * doc/build.scm (guix-mono-node-indexes, guix-split-node-indexes): Link to /manual/devel when %MANUAL is not "guix".
* doc: Produce stylable HTML for @deftp, @deffn, etc.Ludovic Courtès2020-10-19
| | | | | | | | | | | 'makeinfo --help' uses <strong> and <em> for those entries. Replace that with CSS classes. * doc/build.scm (html-manual-identifier-index)[build]: Adjust to handle rewritten forms of <dt> entries. * doc/build.scm (syntax-highlighted-html)[build][syntax-highlight]: Handle <dt> forms and replace them. [highlight-definition, space?]: New procedures.
* doc: Generate cross-references in code snippets to the Guile manual.Ludovic Courtès2020-10-17
| | | | | | | | | | | | | Occurrences of 'list', 'cons', etc. in code snippets now link to the relevant section of the Guile manual. * doc/build.scm (guile-manual, %guile-manual-base-url) (guile-mono-node-indexes, guile-split-node-indexes): New variables. (for-all-languages, merge-index-alists): New procedures. <top level>: Rename 'mono-node-indexes' and 'split-node-indexes' to 'guix-mono-node-indexes' and 'guix-split-node-indexes' respectively. Add 'mono-node-indexes' and 'split-node-indexes' defined as calls to 'merge-index-alists'.
* doc: Allow code snippets in the cookbook to link to the manual.Ludovic Courtès2020-10-17
| | | | | | | | | | | | | Until now, only code snippets in the manual itself would contain links to identifier definitions. Now snippets in the cookbook also link to definitions in the manual. * doc/build.scm (html-manual): Add #:mono-node-indexes and #:multi-node-indexes and pass it to 'syntax-highlighted-html'. (pdf+html-manual): Likewise, and pass it to 'html-manual'. <top level>: Factorize 'version' and 'source'. Define 'guix-manual', 'mono-node-indexes', and 'split-node-indexes'. Pass #:mono-node-indexes and #:split-node-indexes to 'pdf+html-manual'.
* doc: Move manual index creation to a separate derivation.Ludovic Courtès2020-10-17
| | | | | | | | | | * doc/build.scm (normalize-language-code, html-manual-identifier-index): New procedures. (syntax-highlighted-html): Add #:mono-node-indexes and #:split-node-indexes. [build](underscore-decode, anchor-id->key, collect-anchors): Remove. (language+node-anchors, mono-node-anchors, multi-node-anchors): New variables. Use them.
* doc: Remove 'build.scm' from the source of the manual.Ludovic Courtès2020-10-17
| | | | | | | | That way we no longer have to rebuild the whole manual when fiddling with 'build.scm'. * doc/build.scm <top level>: Define 'select?' and pass it to 'pdf+html-manual'.
* doc: Syntax highlighting now handles @var within @lisp.Ludovic Courtès2020-09-04
| | | | | * doc/build.scm (syntax-highlighted-html)[build](concatenate-pieces): Handle @var{name}.
* doc: Remove one use of 'file-append*'.Ludovic Courtès2020-05-25
| | | | | * doc/build.scm (texinfo-manual-source)[build]: Use 'file-append', not 'file-append*', for 'htmlxref.cnf', to ensure it has the right basename.
* doc: Inherit md5.scm fix in custom 'guile-lib' variant.Ludovic Courtès2020-05-18
| | | | | * doc/build.scm (guile-lib/htmlprag-fixed)[source]: Remove. [arguments]: Add 'fix-htmlprag' phase.
* doc: Fix building the cookbook.Björn Höfling2020-05-02
| | | | | | | | | Fixes <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=40803>. Reported by "operator.name" <operator.name@protonmail.com>. * doc/build.scm (%languages): Add smaller list for the cookbook. (syntax-highlighted-html): Adapt regexp for mono-node files to include the cookbook.
* doc: Include *.json files in the source.Ludovic Courtès2020-04-21
| | | | | | This is a followup to c9f321e52a99dea93fcc099372ea0167150b9aac. * doc/build.scm (texinfo-manual-source)[build]: Add *.json to #$output.
* doc: Improve anchor collection.Ludovic Courtès2020-04-13
| | | | | | | This allows us to catch "operating_002dsystem-1", for instance. * doc/build.scm (syntax-highlighted-html)[build](anchor-id->key): Drop "-1" & co. from ID.
* doc: Avoid invalid 'match' pattern in 'syntax-highlighted-html'.Ludovic Courtès2020-04-13
| | | | | | | | | | | | This is a followup to da9deba13d551e316f5a99a614834efa27ddc7d1. Last-minute modification of the 'match' pattern would lead to an error: "multiple ellipsis patterns not allowed at same level" * doc/build.scm (syntax-highlighted-html)[build](collect-anchors): Add 'worthy-entry?' procedure and use it instead of the unsupported pattern for ('dt ...).
* doc: Emit hyperlinks in HTML output for @lisp snippets.Ludovic Courtès2020-04-13
| | | | | | | | | | | | | | | This makes it easier to jump to the definition of a procedure or variable when looking at a code snippet. There can be false-positive because scoping rules are ignored, for example, but it should be a good approximation. * doc/build.scm (syntax-highlighted-html)[build](highlights->sxml*): Add 'anchors' parameter. Add clause for ('symbol text). (syntax-highlight): Add 'anchors' parameter. Wrap body in named let and use it in recursive calls. Pass ANCHORS to 'highlights->sxml*'. (underscore-decode, anchor-id->key, collect-anchors, html?): New procedures. (process-file): Add 'anchors' parameter. and honor it. Rewrite mono-node and multi-node HTML files separately.
* doc: Make sure 'htmlxref.cnf' is honored.Ludovic Courtès2020-01-12
| | | | | | | | Fixes <https://bugs.gnu.org/39060>. Reported by Tobias Geerinckx-Rice <me@tobias.gr>. * doc/build.scm (html-manual)[build]: Copy 'htmlxref.cnf' to the current directory so that 'makeinfo' honors it.
* doc: Handle right arrows in 'syntax-highlighted-html'.Ludovic Courtès2019-11-28
| | | | * doc/build.scm (syntax-highlighted-html)[build](entity->string): Add "rarr".
* doc: Use the right title in HTML indices for the cookbook.Ludovic Courtès2019-10-22
| | | | | * doc/build.scm (html-manual-indexes): Add #:title. [build]: Replace "GNU Guix Reference Manual" by references to TITLE.
* doc: More responsive online manual.Julien Lepiller2019-10-21
| | | | | * doc/build.scm (%makeinfo-html-options): Add viewport to all generated html pages for better mobile device support.
* doc: Add support for "guix-cookbook.texi" to 'build.scm'.Ludovic Courtès2019-10-21
| | | | | | | | | * doc/build.scm (%manual): New variable. (html-manual): #:manual now defaults to %MANUAL. [build]: Define 'language->texi-file-name' and use it. Filter out items of LANGUAGES that lack a .texi file. (pdf-manual, html-manual-indexes, pdf+html-manual): #:manual now defaults to %MANUAL.
* doc: Support paren matching via CSS hover.Ludovic Courtès2019-09-25
| | | | | | * doc/build.scm (syntax-highlighted-html)[build](pair-open/close) (highlights->sxml*): New procedures. (syntax-highlight): Use 'highlights->sxml*'.
* doc: Work around (htmlprag) parser issue.Ludovic Courtès2019-09-07
| | | | | * doc/build.scm (guile-lib/htmlprag-fixed): New variable. (syntax-highlighted-html): Use it instead of GUILE-LIB.
* doc: Highlight Scheme syntax in the HTML output.Ludovic Courtès2019-09-07
| | | | | * doc/build.scm (syntax-highlighted-html): New procedure. (html-manual): Use it.
* doc: Add 'images' directory next to HTML pages.Ludovic Courtès2019-07-16
| | | | * doc/build.scm (html-manual): Add images/ symlinks.
* doc: Build a top-level index of the manuals.Ludovic Courtès2019-07-15
| | | | | | | | | | | Suggested by Julien Lepiller. * doc/build.scm (html-manual-indexes)[build]: Add 'with-extensions'. (translate): Actually honor DOMAIN. Add call to 'bindtextdomain' for ISO-CODES. (%iso639-languages): New variable. (language-code->name, top-level-index): New procedures. Add call to 'write-html' for OUTPUT/index.html.
* doc: Generalize build procedures of HTML indexes.Ludovic Courtès2019-07-15
| | | | | | | | | * doc/build.scm (html-manual-indexes)[build](sxml-index): Generalize; add a 'title' and a 'body' parameter and honor them. (language-index): New procedure. (write-index): Remove. (write-html): New procedure. Use 'write-html' and 'language-index'.
* build: Add 'doc/build.scm' to build on-line copies of the manual.Ludovic Courtès2019-07-07
* doc/build.scm: New file. * Makefile.am (EXTRA_DIST): Add it.
generated by cgit v1.2.3 (git 2.45.0) at 2024-11-29 15:27:32 +0000