Hana Dusíková
dad614cc60
[Documentation] fix invalid links in documentation ( #76502 )
2024-01-09 08:00:20 +01:00
cor3ntin
b7ff03206d
[Documentation] Replace recommonmark by myst-parser ( #65664 )
...
Recommonmark has been deprecated, then archived last year. This was
tracked by: https://github.com/llvm/llvm-iwg/issues/30
See https://github.com/readthedocs/recommonmark
This patch migrates all our doc to use myst
Additional details for bot maintainers: https://discourse.llvm.org/t/maintenance-required-on-sphinx-build-bots/73612
2023-09-25 14:02:39 +02:00
Shao-Ce SUN
0c660256eb
[NFC] Trim trailing whitespace in *.rst
2021-11-15 09:17:08 +08:00
Yaron Keren
1987eb9e9c
[docs] Document how to install sphinx and recommonmark on Ubuntu
...
Differential Revision: https://reviews.llvm.org/D108374
2021-08-19 18:24:17 +03:00
Christian Kühnel
15acaad79d
[doc] added section on generating the html doc
...
Added a new section on generating the html documentation
from the rst/md sources to our documentation.
Background: I wanted to check what my documenation
changes would look like on the website and had a hard
time finding how to do that. So I wanted to save other
folks the effort.
Differential Revision: https://reviews.llvm.org/D107460
2021-08-09 07:27:56 +00:00
Sylvestre Ledru
72fd1033ea
Doc: Links should use https
2020-03-22 22:49:33 +01:00
drichards-87
bcca123bd0
Docs: Updates Sphinx Quickstart template for new contributors
2019-11-10 09:27:32 -07:00
Sean Silva
1b46534445
[docs] Provide pointer for building Sphinx docs.
...
llvm-svn: 176195
2013-02-27 18:33:21 +00:00
Sean Silva
7adbc0eaa4
[docs] Tweaks for clarity, readability, and correctness.
...
llvm-svn: 174749
2013-02-08 21:51:26 +00:00
Chris Lattner
045a73e62d
remove the rest of the "written by" lines in the documentation. It is
...
against the developer policy to include this sort of thing as SVN blame
already captures this in a far more fine-grained way.
llvm-svn: 172109
2013-01-10 21:24:04 +00:00
Sean Silva
f77e570557
docs: Improve discussion of syntax highlighting.
...
llvm-svn: 170145
2012-12-13 20:14:25 +00:00
Dmitri Gribenko
f8bb4eadca
Documentation: SphinxQuickstartTemplate.rst: add guidelines about highlighting
...
console sessions and add more highlighter names.
llvm-svn: 170011
2012-12-12 20:07:18 +00:00
Sean Silva
33af5003c7
docs: Explain plain preformatted text
...
llvm-svn: 169352
2012-12-05 04:07:33 +00:00
Sean Silva
d91ff4c942
docs: Add SphinxQuickstartTemplate.rst.
...
The intent of this document is to be the go-to document for anybody who
wants to write new documentation, but isn't familiar with Sphinx.
llvm-svn: 165775
2012-10-12 00:53:48 +00:00
