Modernize the guides on creating extensions.
Review Request #8523 — Created Nov. 5, 2016 and submitted
This fleshes out the various pages on creating extensions. There's now a new, fully-detailed walkthrough of the extension class and the attributes/methods that need to be used. The guides to the file/package layout and packaging have been updated to talk about Wheels, static media bundling, dependencies, etc. The configuration and static media pages go into more details on the options available, along with examples. The database models page now talks about writing evolution files. The resulting documentation is now a lot more clear, helping truly guide extension authors to getting started. It should be easier for us to continue to maintain and update as we go forward.
Built the docs and went through them, checking for spelling errors (though
it's possible I missed some), links, source code, etc.(Some links are currently broken, just because there are some new pages that
aren't part of this change.)
| Description | From | Last Updated |
|---|---|---|
|
We should probably recommend as a best practice that the version only be defined in the package metadata because people … |
 david
|
|
|
Can you add an import line for the resource instances to this code block? |
david
|
|
|
Should say "raised" instead of "thrown" |
david
|
|
|
Too many spaces between sentences here. |
david
|
|
|
Can we add a warning to never use --hint --execute? |
david
|
|
|
"compiled down" is weird. How about just "compiled to CSS"? |
david
|
-
Great change!
-
docs/manual/extending/extensions/class.rst (Diff revision 1) We should probably recommend as a best practice that the version only be defined in the package metadata because people will forget.
-
docs/manual/extending/extensions/class.rst (Diff revision 1) Can you add an
importline for the resource instances to this code block? -
docs/manual/extending/extensions/configuration.rst (Diff revision 1) Should say "raised" instead of "thrown"
-
docs/manual/extending/extensions/configuration.rst (Diff revision 1) Too many spaces between sentences here.
-
docs/manual/extending/extensions/models.rst (Diff revision 1) Can we add a warning to never use
--hint --execute? -
docs/manual/extending/extensions/static-files.rst (Diff revision 1) "compiled down" is weird. How about just "compiled to CSS"?
Change Summary:
- Added extra advice and warnings for extension metadata and database evolutions.
- Cleaned up some wording.
- Improved an example for using custom API resources.
- Added an intersphinx entry for the Getting Started guide.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 2 (+859 -434) |
-
Tool: Pyflakes Processed Files: docs/manual/conf.py Ignored Files: docs/manual/extending/extensions/file-layout.rst docs/manual/extending/extensions/static-files.rst docs/manual/glossary.rst docs/manual/extending/extensions/distribution.rst docs/manual/extending/extensions/models.rst docs/manual/extending/extensions/configuration.rst docs/manual/extending/extensions/class.rst Tool: PEP8 Style Checker Processed Files: docs/manual/conf.py Ignored Files: docs/manual/extending/extensions/file-layout.rst docs/manual/extending/extensions/static-files.rst docs/manual/glossary.rst docs/manual/extending/extensions/distribution.rst docs/manual/extending/extensions/models.rst docs/manual/extending/extensions/configuration.rst docs/manual/extending/extensions/class.rst
Tool: Pyflakes Processed Files: docs/manual/conf.py Ignored Files: docs/manual/extending/extensions/file-layout.rst docs/manual/extending/extensions/static-files.rst docs/manual/glossary.rst docs/manual/extending/extensions/distribution.rst docs/manual/extending/extensions/models.rst docs/manual/extending/extensions/configuration.rst docs/manual/extending/extensions/class.rst Tool: PEP8 Style Checker Processed Files: docs/manual/conf.py Ignored Files: docs/manual/extending/extensions/file-layout.rst docs/manual/extending/extensions/static-files.rst docs/manual/glossary.rst docs/manual/extending/extensions/distribution.rst docs/manual/extending/extensions/models.rst docs/manual/extending/extensions/configuration.rst docs/manual/extending/extensions/class.rst