Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
First try at documenting a class using the Sphinx defaults. [skip ci]
- Loading branch information
Showing
9 changed files
with
83 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,16 @@ | ||
Buildable views | ||
=============== | ||
|
||
.. class:: BuildableTemplateView | ||
|
||
Renders and builds a simple template as a flat file. When inherited, the child class should include the following attributes. | ||
|
||
.. attribute:: build_path | ||
|
||
The target location of the built file in the ``BUILD_DIR``. | ||
``index.html`` would place it at the built site's root. | ||
``foo/index.html`` would place it inside a subdirectory. | ||
|
||
.. attribute:: template_name | ||
|
||
The name of the template you would like Django to render. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,16 @@ | ||
Buildable views | ||
=============== | ||
|
||
.. class:: BuildableTemplateView | ||
|
||
Renders and builds a simple template as a flat file. When inherited, the child class should include the following attributes. | ||
|
||
.. attribute:: build_path | ||
|
||
The target location of the built file in the ``BUILD_DIR``. | ||
``index.html`` would place it at the built site's root. | ||
``foo/index.html`` would place it inside a subdirectory. | ||
|
||
.. attribute:: template_name | ||
|
||
The name of the template you would like Django to render. |