aboutsummaryrefslogtreecommitdiff
path: root/doc/README.md
AgeCommit message (Collapse)Author
2019-02-09Update link to refman and stdlib doc for master branch.Théo Zimmermann
2018-12-26[dune] Build refman with fatal warnings by default like in the Makefile build.Théo Zimmermann
The way to override this default is not exactly the same as in the legacy Makefile but it has been documented as well.
2018-09-25Fix Sphinx manual targets.Théo Zimmermann
New targets refman, refman-html and refman-pdf. sphinx keeps its previous meaning (compatibility alias for refman-html). install-doc-sphinx has been accidentally renamed.
2018-09-20Define flags (binary-valued settings) and tables (settings that are sets)Jim Fehrle
as separate NotationObject types, include in index.
2018-09-20Update minimum required dependency versions of Sphinx doc.Théo Zimmermann
The minimum required versions of the Sphinx-related (and ANTLR) Python packages for Coq 8.10 were chosen as the lower bound between what is currently in Debian Buster and in NixOS 18.09 Jellyfish (in practice the lower bound was always met by NixOS 18.09 Jellyfish). These minimum required versions were documented. In the docker image used by GitLab CI, we install these Python packages through pip as this allows us to pin them to these specific versions. In Travis, we let them unspecified to always test the latest versions. Finally, we also add the new dependencies of the Sphinx PDF manual.
2018-09-20[doc] Add sphinx-html, sphinx-latex, and sphinx-pdf targetsClément Pit-Claudel
2018-09-03[doc] Build ML API documentation artifact.Emilio Jesus Gallego Arias
This is not optimal for we have to rebuild the `.cmi` as `ocamldoc` cannot yet use the `_install_ci/` directory. Overall the `mli` documentation is in a sorry state, however, I think this is a first step in order to improve it. Note that the `ml-doc` target seems broken in OCaml 4.07.0, needs investigation. cc: #7155
2018-08-29Create SPHINXWARNERROR variable that controls whether the SphinxJim Fehrle
"treat errors as warnings" flag (-W) is applied. "1" or undefined includes the flag, other values or undefined omit it. Removed the "-warn-error" parameter to configure. "-profile XXX" will no longer cause these flags to be used.
2018-06-22Clarify further doc/README.md following Jim's comments.Théo Zimmermann
Relative links. Cf. #7800.
2018-06-22Improve doc/README.md.Théo Zimmermann
- Fix the Markdown. - Add link to latest build of the refman for the master branch. - Clarify what are the dependencies of the HTML doc. [ci skip]
2018-06-22Move INSTALL.doc into doc/README.md.Théo Zimmermann
This will avoid in particular this ambiguous file extension. [ci skip]