Adds documentation for additional reference topics

alexrudy · Mar 25, 2024 · 3502c4a · 3502c4a
1 parent a68cf6d
commit 3502c4a
Show file tree

Hide file tree

Showing 51 changed files with 861 additions and 3 deletions.
diff --git a/docs/api/bootlace.image.Image.rst b/docs/api/bootlace.image.Image.rst
@@ -0,0 +1,23 @@
+Image
+=====
+
+.. currentmodule:: bootlace.image
+
+.. autoclass:: Image
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~Image.alt
+      ~Image.height
+      ~Image.src
+      ~Image.width
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: alt
+   .. autoattribute:: height
+   .. autoattribute:: src
+   .. autoattribute:: width
diff --git a/docs/api/bootlace.links.Link.rst b/docs/api/bootlace.links.Link.rst
@@ -0,0 +1,21 @@
+Link
+====
+
+.. currentmodule:: bootlace.links
+
+.. autoclass:: Link
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~Link.active
+      ~Link.enabled
+      ~Link.url
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: active
+   .. autoattribute:: enabled
+   .. autoattribute:: url
diff --git a/docs/api/bootlace.links.View.rst b/docs/api/bootlace.links.View.rst
@@ -0,0 +1,27 @@
+View
+====
+
+.. currentmodule:: bootlace.links
+
+.. autoclass:: View
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~View.active
+      ~View.enabled
+      ~View.endpoint
+      ~View.ignore_query
+      ~View.url
+      ~View.url_kwargs
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: active
+   .. autoattribute:: enabled
+   .. autoattribute:: endpoint
+   .. autoattribute:: ignore_query
+   .. autoattribute:: url
+   .. autoattribute:: url_kwargs
diff --git a/docs/api/bootlace.nav.NavAlignment.rst b/docs/api/bootlace.nav.NavAlignment.rst
@@ -0,0 +1,21 @@
+NavAlignment
+============
+
+.. currentmodule:: bootlace.nav
+
+.. autoclass:: NavAlignment
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~NavAlignment.DEFAULT
+      ~NavAlignment.FILL
+      ~NavAlignment.JUSTIFIED
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: DEFAULT
+   .. autoattribute:: FILL
+   .. autoattribute:: JUSTIFIED
diff --git a/docs/api/bootlace.nav.NavStyle.rst b/docs/api/bootlace.nav.NavStyle.rst
@@ -0,0 +1,23 @@
+NavStyle
+========
+
+.. currentmodule:: bootlace.nav
+
+.. autoclass:: NavStyle
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~NavStyle.PILLS
+      ~NavStyle.PLAIN
+      ~NavStyle.TABS
+      ~NavStyle.UNDERLINE
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: PILLS
+   .. autoattribute:: PLAIN
+   .. autoattribute:: TABS
+   .. autoattribute:: UNDERLINE
diff --git a/docs/api/bootlace.nav.elements.Brand.rst b/docs/api/bootlace.nav.elements.Brand.rst
@@ -0,0 +1,17 @@
+Brand
+=====
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: Brand
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~Brand.id
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: id
diff --git a/docs/api/bootlace.nav.elements.Dropdown.rst b/docs/api/bootlace.nav.elements.Dropdown.rst
@@ -0,0 +1,19 @@
+Dropdown
+========
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: Dropdown
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~Dropdown.id
+      ~Dropdown.title
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: id
+   .. autoattribute:: title
diff --git a/docs/api/bootlace.nav.elements.Link.rst b/docs/api/bootlace.nav.elements.Link.rst
@@ -0,0 +1,37 @@
+Link
+====
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: Link
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~Link.active
+      ~Link.enabled
+      ~Link.id
+      ~Link.link
+      ~Link.url
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~Link.with_url
+      ~Link.with_view
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: active
+   .. autoattribute:: enabled
+   .. autoattribute:: id
+   .. autoattribute:: link
+   .. autoattribute:: url
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: with_url
+   .. automethod:: with_view
diff --git a/docs/api/bootlace.nav.elements.Nav.rst b/docs/api/bootlace.nav.elements.Nav.rst
@@ -0,0 +1,21 @@
+Nav
+===
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: Nav
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~Nav.alignment
+      ~Nav.id
+      ~Nav.style
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: alignment
+   .. autoattribute:: id
+   .. autoattribute:: style
diff --git a/docs/api/bootlace.nav.elements.NavBar.rst b/docs/api/bootlace.nav.elements.NavBar.rst
@@ -0,0 +1,25 @@
+NavBar
+======
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: NavBar
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~NavBar.color
+      ~NavBar.expand
+      ~NavBar.fluid
+      ~NavBar.id
+      ~NavBar.items
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: color
+   .. autoattribute:: expand
+   .. autoattribute:: fluid
+   .. autoattribute:: id
+   .. autoattribute:: items
diff --git a/docs/api/bootlace.nav.elements.NavBarCollapse.rst b/docs/api/bootlace.nav.elements.NavBarCollapse.rst
@@ -0,0 +1,17 @@
+NavBarCollapse
+==============
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: NavBarCollapse
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~NavBarCollapse.id
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: id
diff --git a/docs/api/bootlace.nav.elements.NavBarNav.rst b/docs/api/bootlace.nav.elements.NavBarNav.rst
@@ -0,0 +1,17 @@
+NavBarNav
+=========
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: NavBarNav
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~NavBarNav.id
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: id
diff --git a/docs/api/bootlace.nav.elements.NavBarSearch.rst b/docs/api/bootlace.nav.elements.NavBarSearch.rst
@@ -0,0 +1,25 @@
+NavBarSearch
+============
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: NavBarSearch
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~NavBarSearch.action
+      ~NavBarSearch.button
+      ~NavBarSearch.id
+      ~NavBarSearch.method
+      ~NavBarSearch.placeholder
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: action
+   .. autoattribute:: button
+   .. autoattribute:: id
+   .. autoattribute:: method
+   .. autoattribute:: placeholder
diff --git a/docs/api/bootlace.nav.elements.Separator.rst b/docs/api/bootlace.nav.elements.Separator.rst
@@ -0,0 +1,7 @@
+Separator
+=========
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: Separator
+   :show-inheritance:
diff --git a/docs/api/bootlace.nav.elements.Text.rst b/docs/api/bootlace.nav.elements.Text.rst
@@ -0,0 +1,19 @@
+Text
+====
+
+.. currentmodule:: bootlace.nav.elements
+
+.. autoclass:: Text
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~Text.enabled
+      ~Text.text
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: enabled
+   .. autoattribute:: text
diff --git a/docs/api/bootlace.size.SizeClass.rst b/docs/api/bootlace.size.SizeClass.rst
@@ -0,0 +1,37 @@
+SizeClass
+=========
+
+.. currentmodule:: bootlace.size
+
+.. autoclass:: SizeClass
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~SizeClass.EXTRA_EXTRA_LARGE
+      ~SizeClass.EXTRA_LARGE
+      ~SizeClass.EXTRA_SMALL
+      ~SizeClass.LARGE
+      ~SizeClass.MEDIUM
+      ~SizeClass.SMALL
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~SizeClass.add_to_class
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: EXTRA_EXTRA_LARGE
+   .. autoattribute:: EXTRA_LARGE
+   .. autoattribute:: EXTRA_SMALL
+   .. autoattribute:: LARGE
+   .. autoattribute:: MEDIUM
+   .. autoattribute:: SMALL
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: add_to_class