Skip to content

Commit

Permalink
doc: minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
azmeuk committed Dec 17, 2024
1 parent 8e23200 commit 765d945
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 15 deletions.
19 changes: 19 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
version: 2
sphinx:
configuration: doc/conf.py
build:
os: "ubuntu-22.04"
apt_packages:
- libsasl2-dev
- libldap2-dev
- libssl-dev
tools:
python: "3.12"
jobs:
post_create_environment:
- pip install uv
- uv export --group doc --no-hashes --output-file requirements.txt
post_install:
- pip install .
- pip install --requirement requirements.txt
18 changes: 3 additions & 15 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Documenting jinja templates
This contrib extension, :mod:`jinja_autodoc`, provides a Sphinx
domain for describing jinja templates.

This package is available on PyPI as `jinja-autodoc`.

In order to use it, add :mod:`jinja_autodoc` into
:data:`extensions` list of your Sphinx configuration file (:file:`conf.py`)::

Expand Down Expand Up @@ -97,23 +99,9 @@ Directives
Author and License
==================

The :mod:`sphinxcontrib.jinja` and :mod:`sphinxcontrib.autojinja`,
parts of :mod:`sphinxcontrib`, was originally written by `Jaka Hudoklin`_,
The project was originally written by `Jaka Hudoklin`_,
and then `forked <https://github.com/offlinehacker/sphinxcontrib.jinjadomain>`__ and maintained
by `Yaal Coop`_ and distributed under BSD license.

The source code is mantained under `the common repository of contributed
extensions for Sphinx`__ (find the :file:`jinja` directory inside
the repository).

.. sourcecode:: console

$ git clone git://github.com/azmeuk/sphinxcontrib.jinja.git
$ cd jinja
$ python setup.py install

This package is also avalible on PyPI as `sphinxcontrib-jinja`

.. _Jaka Hudoklin: http://www.offlinehacker.net/
.. _Yaal Coop: https://yaal.coop
__ https://github.com/azmeuk/sphinxcontrib.jinja

0 comments on commit 765d945

Please sign in to comment.