diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..0898e7a --- /dev/null +++ b/.readthedocs.yml @@ -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 diff --git a/doc/index.rst b/doc/index.rst index a2be505..efc41f1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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`):: @@ -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 `__ 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