Skip to content

Commit 582823d

Browse files
authored
Add Antora docs page (#11947)
<!-- readthedocs-preview docs start --> --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--11947.org.readthedocs.build/en/11947/ <!-- readthedocs-preview docs end --> <!-- readthedocs-preview dev start --> - Developer's documentation (`dev`): https://dev--11947.org.readthedocs.build/en/11947/ <!-- readthedocs-preview dev end -->
1 parent 5b03ee1 commit 582823d

File tree

3 files changed

+64
-3
lines changed

3 files changed

+64
-3
lines changed

docs/user/examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Sphinx example with versioning and Python doc autogeneration.
2222
Markup language
2323
reStructuredText, Markdown or MyST
2424
Rendered version
25-
https://example-sphinx-basic.readthedocs.io/en/latest/>
25+
https://example-sphinx-basic.readthedocs.io/en/latest/
2626
Repository
2727
https://github.com/readthedocs-examples/example-sphinx-basic/
2828

docs/user/intro/antora.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
Antora
2+
======
3+
4+
.. meta::
5+
:description lang=en: Hosting Antora documentation on Read the Docs.
6+
7+
`Antora`_ is a static site generator for creating documentation sites from AsciiDoc content.
8+
9+
Minimal configuration is required to build an existing Antora project on Read the Docs.
10+
11+
.. code-block:: yaml
12+
:caption: .readthedocs.yaml
13+
14+
version: 2
15+
16+
build:
17+
os: ubuntu-lts-latest
18+
tools:
19+
nodejs: latest
20+
jobs:
21+
install:
22+
- npm i -g @antora/[email protected] @antora/[email protected]
23+
build:
24+
html:
25+
- antora --fetch antora-playbook.yml --to-dir $READTHEDOCS_OUTPUT/html
26+
27+
.. _Antora: https://antora.org/
28+
29+
Getting Started
30+
---------------
31+
32+
- If you have an existing Antora project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide.
33+
- If you're new to Antora, check out the official `Getting Started with Antora`_ guide.
34+
35+
.. _Getting Started with Antora: https://docs.antora.org/antora/latest/install-and-run-quickstart/
36+
37+
Example Repository and Demo
38+
---------------------------
39+
40+
Example repository
41+
https://github.com/readthedocs/test-builds/tree/antora
42+
43+
Demo
44+
https://test-builds.readthedocs.io/en/antora/
45+
46+
Further Reading
47+
---------------
48+
49+
* `Antora documentation`_
50+
51+
.. _Antora documentation: https://docs.antora.org/antora/latest/

docs/user/intro/doctools.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ Below is a list of popular documentation tools that you can use to write your do
2424
Written in
2525
:bdg-info:`python`
2626

27-
2827
.. grid-item-card:: Sphinx
2928
:link: sphinx.html
3029

@@ -35,7 +34,7 @@ Below is a list of popular documentation tools that you can use to write your do
3534
Written in
3635
:bdg-info:`python`
3736

38-
.. grid-item-card:: Docusarus
37+
.. grid-item-card:: Docusaurus
3938
:link: docusaurus.html
4039

4140
Docusaurus is a static-site generator that builds a single-page application with fast client-side navigation and out-of-the-box documentation features.
@@ -65,6 +64,16 @@ Below is a list of popular documentation tools that you can use to write your do
6564
Written in
6665
:bdg-info:`rust`
6766

67+
.. grid-item-card:: Antora
68+
:link: antora.html
69+
70+
Antora is a static site generator for creating documentation sites from AsciiDoc content.
71+
72+
Supported formats
73+
:bdg-success:`adoc`
74+
Written in
75+
:bdg-info:`javascript`
76+
6877
.. toctree::
6978
:hidden:
7079

@@ -73,3 +82,4 @@ Below is a list of popular documentation tools that you can use to write your do
7382
/intro/docusaurus
7483
/intro/markdoc
7584
/intro/mdbook
85+
/intro/antora

0 commit comments

Comments
 (0)