Skip to content

Commit

Permalink
Add Antora docs page (#11947)
Browse files Browse the repository at this point in the history
<!-- 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 -->
  • Loading branch information
ericholscher authored Jan 23, 2025
1 parent 5b03ee1 commit 582823d
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/user/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Sphinx example with versioning and Python doc autogeneration.
Markup language
reStructuredText, Markdown or MyST
Rendered version
https://example-sphinx-basic.readthedocs.io/en/latest/>
https://example-sphinx-basic.readthedocs.io/en/latest/
Repository
https://github.com/readthedocs-examples/example-sphinx-basic/

Expand Down
51 changes: 51 additions & 0 deletions docs/user/intro/antora.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
Antora
======

.. meta::
:description lang=en: Hosting Antora documentation on Read the Docs.

`Antora`_ is a static site generator for creating documentation sites from AsciiDoc content.

Minimal configuration is required to build an existing Antora project on Read the Docs.

.. code-block:: yaml
:caption: .readthedocs.yaml
version: 2
build:
os: ubuntu-lts-latest
tools:
nodejs: latest
jobs:
install:
- npm i -g @antora/[email protected] @antora/[email protected]
build:
html:
- antora --fetch antora-playbook.yml --to-dir $READTHEDOCS_OUTPUT/html
.. _Antora: https://antora.org/

Getting Started
---------------

- If you have an existing Antora project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide.
- If you're new to Antora, check out the official `Getting Started with Antora`_ guide.

.. _Getting Started with Antora: https://docs.antora.org/antora/latest/install-and-run-quickstart/

Example Repository and Demo
---------------------------

Example repository
https://github.com/readthedocs/test-builds/tree/antora

Demo
https://test-builds.readthedocs.io/en/antora/

Further Reading
---------------

* `Antora documentation`_

.. _Antora documentation: https://docs.antora.org/antora/latest/
14 changes: 12 additions & 2 deletions docs/user/intro/doctools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Below is a list of popular documentation tools that you can use to write your do
Written in
:bdg-info:`python`


.. grid-item-card:: Sphinx
:link: sphinx.html

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

.. grid-item-card:: Docusarus
.. grid-item-card:: Docusaurus
:link: docusaurus.html

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

.. grid-item-card:: Antora
:link: antora.html

Antora is a static site generator for creating documentation sites from AsciiDoc content.

Supported formats
:bdg-success:`adoc`
Written in
:bdg-info:`javascript`

.. toctree::
:hidden:

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

0 comments on commit 582823d

Please sign in to comment.