summaryrefslogtreecommitdiff
path: root/docs/users_guide/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* Set dynamic users-guide TOC spacing (fixes #18554)Tim Barnes2020-11-261-0/+3
|
* Various documentation fixesKrzysztof Gogolewski2020-09-251-5/+2
| | | | | | | | | | | * Remove UnliftedFFITypes from conf. Some time ago, this extension was undocumented and we had to silence a warning. This is no longer needed. * Use r'' in conf.py. This fixes a Sphinx warning: WARNING: Support for evaluating Python 2 syntax is deprecated and will be removed in Sphinx 4.0. Convert docs/users_guide/conf.py to Python 3 syntax. * Mark GHCForeignImportPrim as documented * Fix formatting in template_haskell.rst * Remove 'recursive do' from the list of unsupported items in TH
* Tweak man page for ghc commandTakenobu Tani2020-05-131-1/+1
| | | | | | | | | | This commit updates the ghc command's man page as followings: * Enable `man_show_urls` to show URL addresses in the `DESCRIPTION` section of ghc.rst, because sphinx currently removes hyperlinks for man pages. * Add a `SEE ALSO` section to point to the GHC homepage
* users guide: Move eventlog documentation users guideBen Gamari2020-05-031-0/+10
|
* Use correct option name (-opti) (fix #17314)Sylvain Henry2020-03-141-4/+0
| | | | s/pgmo/opti
* docs: correct relative links to haddocks from users guide (fixes #17866)Adam Sandberg Ericsson2020-02-291-2/+29
|
* Switch to ReadTheDocs theme for the user-guideSylvain Henry2019-12-251-2/+2
|
* users guide: Try to silence underfull \hbox warningsBen Gamari2019-12-051-0/+4
| | | | | | | We use two tricks, as suggested here [1]: * Use microtype to try to reduce the incidence of underfull boxes * Bump up \hbadness to eliminate the warnings
* users-guide: Run sphinx in nit-picky modeBen Gamari2019-10-081-0/+23
| | | | This ensure that it blurts an error on missing references.
* users-guide: Rework pragma key generationBen Gamari2019-10-081-6/+8
| | | | | | Previously we had a hack to handle the case of multi-token SPECIALISE pragmas. Now we use a slightly more general rule of using a prefix of tokens containing only alphabetical characters.
* Fix some warnings in users_guide (incl #16640)Oleg Grenrus2019-05-291-1/+8
| | | | | | | | | | | | | | - short underline - :ghc-flag:, not :ghc-flags: - :since: have to be separate - newline before code block - workaround anchor generation so - pragma:SPECIALISE - pragma:SPECIALIZE-INLINE - pragma:SPECIALIZE-inline are different anchors, not all the same `pragma:SPECIALIZE`
* users guide: fix typesetting of pragmasBen Price2019-01-231-3/+4
|
* users guide: Introduce :pragma: directiveBen Gamari2018-10-291-0/+14
|
* users-guide: Override mathjax_pathBen Gamari2018-04-191-0/+3
| | | | | | | | | | | | | | | | | | The Mathjax CDN no longer exists. Use CDNJS instead. See #15006. Test Plan: Build HTML users guide, see whether math is rendered. Reviewers: alpmestan Reviewed By: alpmestan Subscribers: thomie, carter GHC Trac Issues: #15006 Differential Revision: https://phabricator.haskell.org/D4603
* users-guide: Consistently document LLVM version requirementBen Gamari2017-12-141-0/+4
| | | | (cherry picked from commit fdccc6666d838cf8708b9fc03a9ce2aa04fe9439)
* relnotes: Rework treatment of included package listBen Gamari2017-11-271-1/+5
| | | | | | | | | | Previously the included package lists took a disproportionate amount of space in the resulting document and were difficult to maintain. Turn it into a table. Subscribers: rwbarton, thomie Differential Revision: https://phabricator.haskell.org/D4230
* users_guide: Convert mkUserGuidePart generation to a Sphinx extensionPatrick Dougherty2017-08-181-12/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This removes all dependencies the users guide had on `mkUserGuidePart`. The generation of the flag reference table and the various pieces of the man page is now entirely contained within the Spinx extension `flags.py`. You can see the man page generation on the orphan page https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/ghc.html The extension works by collecting all of the meta-data attached to the `ghc-flag` directives and then formatting and displaying it at `flag-print` directives. There is a single printing directive that can be customized with two options, what format to display (table, list, or block of flags) and an optional category to limit the output to (verbosity, warnings, codegen, etc.). New display formats can be added by creating a function `generate_flag_xxx` (where `xxx` is a description of the format) which takes a list of flags and a category and returns a new `xxx`. Then just add a reference in the dispatch table `handlers`. That display can now be run by passing `:type: xxx` to the `flag-print` directive. `flags.py` contains two maps of settings that can be adjusted. The first is a canonical list of flag categories, and the second sets default categories for files. The only functionality that Sphinx could not replace was the `what_glasgow_exts_does.gen.rst` file. `mkUserGuidePart` actually just reads the list of flags from `compiler/main/DynFlags.hs` which Sphinx cannot do. As the flag is deprecated, I added the list as a static file which can be updated manually. Additionally, this patch updates every single documented flag with the data from `mkUserGuidePart` to generate the reference table. Fixes #11654 and, incidentally, #12155. Reviewers: austin, bgamari Subscribers: rwbarton, thomie GHC Trac Issues: #11654, #12155 Differential Revision: https://phabricator.haskell.org/D3839
* users-guide: Make it easier to reference haddocksBen Gamari2017-07-241-0/+41
| | | | | | | | | | | | | | Previously you had to painstakingly construct the URI to the haddock documentation. Now the Python bits have enough smarts to construct this themselves. Reviewers: austin, patrickdoc Reviewed By: patrickdoc Subscribers: rwbarton, thomie Differential Revision: https://phabricator.haskell.org/D3785
* Fix more documentation wibblesBen Gamari2017-07-231-1/+1
| | | | Fixes #14020, #14016, #14015, #14019
* users-guide: Standardize and repair all flag referencesPatrick Dougherty2017-07-231-24/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch does three things: 1.) It simplifies the flag parsing code in `conf.py` to properly display flag definitions created by `.. (ghc|rts)-flag::`. Additionally, all flag references must include the associated arguments. Documentation has been added to `editing-guide.rst` to explain this. 2.) It normalizes all flag definitions to a similar format. Notably, all instances of `<>` have been replaced with `⟨⟩`. All references across the users guide have been updated to match. 3.) It fixes a couple issues with the flag reference table's generation code, which did not handle comma separated flags in the same cell and did not properly reference flags with arguments. Test Plan: `SPHINXOPTS = -n` to activate "nitpicky" mode, which reports all broken references. All remaining errors are references to flags without any documentation. Reviewers: austin, bgamari Reviewed By: bgamari Subscribers: rwbarton, thomie GHC Trac Issues: #13980 Differential Revision: https://phabricator.haskell.org/D3778
* Fix "Glasgow Haskell Compiler <release> Users Guide"Bartosz Nitka2017-04-171-1/+1
| | | | | | | | | | | | | | | | | | | | | If you go to https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/index.html the window title has `<release>` in it. I don't understand how it all works, but inspired by the line below which produces a correct string in the docs I just blindly changed it in the same way. Cabal appears to have the same problem. Test Plan: it'd be nice if I could check the result on harbormaster, can I? Reviewers: thomie, bgamari, austin Reviewed By: bgamari Subscribers: rwbarton, simonmar Differential Revision: https://phabricator.haskell.org/D3458
* Spelling fixesGabor Greif2017-02-021-5/+5
|
* users-guide: Produce OpenSearch descriptionBen Gamari2017-01-101-0/+1
| | | | | | | | | | Reviewers: austin, hsyl20 Reviewed By: hsyl20 Subscribers: thomie Differential Revision: https://phabricator.haskell.org/D2921
* Clarify pkg selection when multiple versions are availableHarendra Kumar2016-08-301-3/+3
| | | | | | | | | | Reviewers: austin, bgamari, ezyang Reviewed By: ezyang Subscribers: thomie Differential Revision: https://phabricator.haskell.org/D2464
* users-guide: Remove static field type from rts-flagBen Gamari2016-07-041-1/+0
| | | | This was introduced by a cut-and-paste error.
* users-guide: Fix index in PDF outputBen Gamari2016-05-211-0/+1
| | | | The madness that is latex never ceases to amaze.
* sphinx-build: fix python stack overflow (Trac #10950)Sergei Trofimovich2016-01-211-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Summary: commit a034031a102bc08c76a6cdb104b72922ae22c96b did not fix problem completely. Stack overflows still occasionally happen. Easy to test by the following Torture Test: while sphinx-build -T -N -E -a -b html \ -d docs/users_guide/.doctrees-html \ -D latex_paper_size=letter \ docs/users_guide docs/users_guide/build-html/users_guide do echo again done sphinx build large nested data structures when parses GHC manual (docs/users_guide/glasgow_exts.rst is 455KB in size) which can't be serialized useing default python call stack depth of 1000 calls. The patch increases stack depth 10 times. Survived 2 hours of Torture Test. Signed-off-by: Sergei Trofimovich <siarheit@google.com> Test Plan: ran Torture Test to make sure it is stable Reviewers: austin, bgamari Reviewed By: bgamari Subscribers: thomie Differential Revision: https://phabricator.haskell.org/D1809 GHC Trac Issues: #10950
* users_guide: Use semantic directive/role for command line optionsBen Gamari2016-01-091-1/+48
| | | | | | And GHCi commands. This makes cross-referencing much easier. Also normalize markup a bit and add some missing flags.
* users_guide: Add ghci-cmd directiveBen Gamari2016-01-041-0/+14
| | | | | | | | | | | | | Note only does this make the markup cleaner and more semantic, but it clears up some warnings and enables proper hyperlinks. Yay Sphinx! While I was at it I generally cleaned up the markup Test Plan: Read it Reviewers: hvr, thomie, austin Differential Revision: https://phabricator.haskell.org/D1730
* users-guide: Fix typo in conf.pyBen Gamari2015-11-181-1/+1
| | | | inputenv /= inputenc
* users-guide: Use tango pygments styleBen Gamari2015-11-181-1/+1
|
* Move user's guide to ReStructuredTextBen Gamari2015-10-031-0/+112
View Lorry Controller Status