Skip to content

Commit

Permalink
Docs improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
boxed committed Aug 27, 2024
1 parent e74c223 commit 5f1a440
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/test_doc_forms.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
def test_forms():
# language=rst
"""
.. _forms:
Forms
=====
Expand Down
11 changes: 9 additions & 2 deletions docs/test_doc_pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@
def test_pages():
# language=rst
"""
.. _pages:
Pages
=====
iommi pages are used to compose parts of a page into a full page.
iommi pages are used to compose parts of a page into a full page. A "part" can be any iommi component (like :ref:`Table <tables>`, :ref:`Form <forms>`, :doc:`Fragment`), or a plain Python string, or a Django `Template <https://docs.djangoproject.com/en/5.1/topics/templates/>`_.
The `html`_ builder function is used to create simple :doc:`Fragment`s for div, h1, span, etc.
"""


def test_example():
# language=rst
Expand Down Expand Up @@ -103,6 +107,9 @@ class MyPage(Page):

# language=rst
"""
.. _html:
html
----
Expand Down
3 changes: 3 additions & 0 deletions docs/test_doc_tables.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ def fill_dummy_data(): pass
def test_tables(really_big_discography):
# language=rst
"""
.. _tables:
Tables
======
Expand Down

0 comments on commit 5f1a440

Please sign in to comment.