aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx/introduction.rst
AgeCommit message (Collapse)Author
2020-12-30Convert rewriting and proof-mode chapters to prodnJim Fehrle
2020-11-09[refman] Stop applying a special style to Coq, CoqIDE, OCaml and Gallina.Théo Zimmermann
The smallcaps rendering was inexistent in the PDF version and did not look good in the HTML version.
2020-10-20Add some missing smallcaps.Théo Zimmermann
2020-03-19[refman] Move chapters into new structure.Théo Zimmermann
As a first step toward a deeper refactoring of the reference manual, we move existing chapters into a new structure. We use the Sphinx support for top-level chapters spanning multiple pages to consolidate existing chapters into a smaller number of chapters and a smaller number of parts. Now the full top-level table of content can be seen in one glance. Most of the new chapters are divided into several sub-chapters (on separate pages) that correspond to the pre-existing chapters. These new top-level chapters gathering several chapters together have gained a new introduction. The main introduction has been rewritten / simplified as well. For now, the URL of pre-existing chapters does not change. The intent is to further refactor the manual by splitting some of these sub-chapters into smaller ones, and by moving things around. While the sub-chapters are likely to evolve very much in the future, the top-level table of content is almost final (except that the "Using Coq" part may gain one or two additional chapters on proof engineering / project management). Thanks to Jim Fehrle for investigating how to split a chapter on multiple pages and to both Jim and Matthieu Sozeau for the discussion that led to this new structure. See also the related CEP: https://github.com/coq/ceps/pull/43 Additional notes: - A new directory structure has been created reflecting the new chapter structure. - The indexes chapter has been removed from the PDF version since it wasn't working. Co-authored-by: Jim Fehrle <jfehrle@sbcglobal.net>
2019-12-22Apply suggestions from code reviewThéo Zimmermann
Co-Authored-By: Jim Fehrle <jim.fehrle@gmail.com>
2019-12-22[refman] Mention Ltac2 in intro.Théo Zimmermann
2018-10-10Include all menu entries in the menu/short TOC so that users can viewJim Fehrle
menu options for all chapters without having to load a new chapter. Change "Introcution" title to "Introduction and Contents"
2018-09-25Fix title of Introduction chapter in HTML version.Théo Zimmermann
And location of footnote.
2018-09-20[doc] Move a citation back into the introductionClément Pit-Claudel
Alternatively, we could duplicate the citation text in both index files.
2018-09-20[doc] Include the rst and LaTeX preambles automatically in all filesClément Pit-Claudel
2018-09-20[doc] Create a separate index file for the LaTeX buildClément Pit-Claudel
See https://github.com/sphinx-doc/sphinx/issues/4977 for context.
2018-08-31Uniformized many spelling variants. Added .. warning:: and .. seealso:: ↵Zeimer
directives in many places. Disambiguated terminology: disequality now means <> while inequality means < <= > >=. Fixed some more grammar and spelling issues.
2018-07-12Fixed typos, wording and grammar errors in the Preamble of the Reference ↵Zeimer
Manual (Introduction, Credits).
2018-06-26Merge PR #7851: Modernize the introduction of the reference manual.Maxime Dénès
2018-06-24Merge PR #7784: Remove Tutorials from a few other places following #7466.Maxime Dénès
2018-06-20Mention Company-Coq as well.Théo Zimmermann
We put it in a footnote otherwise the sentence was starting to be really long. Footnotes need to be in index.rst to really appear at the bottom of the index page.
2018-06-20Add a good reference for Proof-General as suggested by Clément.Théo Zimmermann
2018-06-20Modernize the introduction of the reference manual.Théo Zimmermann
2018-06-17Remove Tutorial from Additional documentation in refman intro.Théo Zimmermann
2018-06-17Add introduction and credits to the TOC.Théo Zimmermann
Move credits to its own chapter (closes #6573).
2018-05-10Suggest going to /documentation to see a list of tutorials.Théo Zimmermann
2018-04-14[Sphinx] Fix all remaining warnings.Maxime Dénès
2018-04-11Remove empty reference to the current version of Coq.Théo Zimmermann
2018-03-13[Sphinx] Add introductionMaxime Dénès
I backported changes done to the LaTeX manual.
2018-03-13[Sphinx] Move introduction to new infrastructureMaxime Dénès