Autodoc the plugins toolkit somehow #847

Closed
seanh opened this Issue Apr 30, 2013 · 4 comments

Projects

None yet

2 participants

@seanh
Contributor
seanh commented Apr 30, 2013

Reference docs for the plugins toolkit should be pulled from the source code, but this is difficult because of circular import issues.

Contributor
tobes commented May 1, 2013

The only practical way to do this is via a paster command or similar - would that be acceptable?

Contributor
seanh commented May 22, 2013

I think a paster command would be fine, yes.

P.S. We also need to autodoc the paster commands docs! Haven't looked into the practicality of this yet

Contributor
tobes commented May 22, 2013

I'm for a sphinx extension it'd just work

@seanh seanh pushed a commit that referenced this issue Aug 21, 2013
Sean Hammond [#847] Add a TODO 9a70373
Contributor
seanh commented Aug 29, 2013

Done in #943

@seanh seanh closed this Aug 29, 2013
@seanh seanh pushed a commit that referenced this issue Sep 4, 2013
Sean Hammond [#847] More work on the new theming docs
Completed first draft of most of the templates stuff.
Still needs a lot of work.
1fce2cc
@seanh seanh pushed a commit that referenced this issue Sep 9, 2013
Sean Hammond [#847] Remove a TODO that doesn't belong 751871f
@seanh seanh pushed a commit that referenced this issue Sep 9, 2013
Sean Hammond [#847] Docs: add ckanext-example_theme Sphinx substitution 0cbea1d
@seanh seanh pushed a commit that referenced this issue Sep 9, 2013
Sean Hammond [#847] example_theme plugin_v2 tweaks
Comments, add a missing import
a4e0aaf
@seanh seanh pushed a commit that referenced this issue Sep 9, 2013
Sean Hammond [#847] example_theme plugin_v7 tweaks
Comments, etc.
6d33afc
@seanh seanh pushed a commit that referenced this issue Sep 9, 2013
Sean Hammond [#847] Lots of theming docs tweaks
Use substitutions for lots of things, and also lots of text tweaks, new
stuff about how to find out which template a page uses, global
variables, etc.
e77af56
@seanh seanh pushed a commit that referenced this issue Sep 9, 2013
Sean Hammond [#847] Add templating {{ super() }} example 51d2e7a
@seanh seanh pushed a commit that referenced this issue Sep 9, 2013
Sean Hammond [#847] Rename all the theming example dirs
This just makes it a little easier to keep track of which example is
which
7dd3889
@seanh seanh pushed a commit that referenced this issue Sep 9, 2013
Sean Hammond [#847] Add missing templates_dir substitution 8a195e9
@seanh seanh pushed a commit that referenced this issue Sep 11, 2013
Sean Hammond [#847] Tweak a theming example 655d56f
@seanh seanh pushed a commit that referenced this issue Sep 11, 2013
Sean Hammond [#847] Improve custom snippet example d6abcde
@seanh seanh pushed a commit that referenced this issue Sep 11, 2013
Sean Hammond [#847] Correct a couple of typos 7de4aac
@seanh seanh pushed a commit that referenced this issue Sep 11, 2013
Sean Hammond [#847] Tweak warning about snippet overriding a56c231
@seanh seanh pushed a commit that referenced this issue Sep 11, 2013
Sean Hammond [#847] Add note about snippet filenames f8fe2d8
@seanh seanh pushed a commit that referenced this issue Sep 11, 2013
Sean Hammond [#847] Correct note about snippets and global variables 3065319
@seanh seanh pushed a commit that referenced this issue Sep 11, 2013
Sean Hammond [#847] Add a note to the theming docs 40ef2f9
@seanh seanh pushed a commit that referenced this issue Sep 11, 2013
Sean Hammond [#847] Add basic intro to Jinja
Expressions, tags, and what's available in the  global namespace.
0af3d0d
@seanh seanh pushed a commit that referenced this issue Sep 12, 2013
Sean Hammond [#847] Clarify about variables passed into snippets bc08d24
@seanh seanh pushed a commit that referenced this issue Sep 12, 2013
Sean Hammond [#847] Add a TODO 389f65d
@seanh seanh pushed a commit that referenced this issue Sep 12, 2013
Sean Hammond [#847] Change dataset of the day example to most popular groups
Change the dataset of the day example in the theming docs to a most
popular groups example.
855418f
@seanh seanh pushed a commit that referenced this issue Sep 12, 2013
Sean Hammond [#847] Update a Sphinx reference 19057c7
@seanh seanh pushed a commit that referenced this issue Sep 12, 2013
Sean Hammond [#847] Add limit param to recently_changed_packages_activity_list tem…
…plate helper function
b6abbed
@seanh seanh pushed a commit that referenced this issue Sep 12, 2013
Sean Hammond [#847] Add an HTML and CSS example to the theming tutorial
Also remove a duplicated section about global template variables.
0745c0e
@seanh seanh pushed a commit that referenced this issue Sep 24, 2013
Sean Hammond [#847] Remove a duplicated section from theming docs a6fa2a9
@seanh seanh pushed a commit that referenced this issue Oct 7, 2013
Sean Hammond [#847] Add extra_public_paths example 3c7f6c8
@seanh seanh pushed a commit that referenced this issue Nov 18, 2013
Sean Hammond [#847] Add draft Fanstatic tutorial 9beb8cb
@seanh seanh pushed a commit that referenced this issue Nov 19, 2013
Sean Hammond [#847] Add extensions CSS tutorial 356ee39
@seanh seanh pushed a commit that referenced this issue Nov 20, 2013
Sean Hammond [#847] Add draft of first JavaScript tutorial 983bb02
@seanh seanh pushed a commit that referenced this issue Nov 21, 2013
Sean Hammond [#847] Break up theming tutorial into multiple pages a8a13b2
@seanh seanh pushed a commit that referenced this issue Nov 21, 2013
Sean Hammond [#847] Fix Sphinx errors in helpers.py 4266fdc
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Typo c1d28aa
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Add pre-reqs to theming tutorial c44ee25
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Fix a broken comment 86b794e
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Begin cleaning up theming tutorial
Some of the examples still need to be updated to reflect changes in master.

* Rename the various example_theme extensions with a leading 0, e.g.
  v01_empty_extension etc.

* Add v03_jinja, this example was previously inline in the docs, move into
  a working and testable extension, update the docs to include it.

  Note that this means all the following versions of the example extension
  are renamed, as their version numbers are bumped.

* Update setup.py.

* css.rst: Update literalinclude's.

* static-files.rst: Update literalinclude's and images.

* templates.rst, substitutions.rst: Update literalinclude's, various tweaks
  and improvements. Add screenshot of debug footer.
a128a9c
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Add Jinja blocks to homepage layouts 3d5c715
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Update template blocks example 6e97fbc
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Update {{ super() }} example in docs c5cfc08
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Update template helper function example e19a1d3
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Update custom helper function example d925116
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Update template snippets example 9a0b71b
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Update custom snippet example cacb133
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Add beginning of theming best practices page e98dfc7
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Update HTML tags and CSS classes example 9c9dda6
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Delete a couple of TODOs ca43d01
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Update static files example 275b8ed
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Add user guide and sysadmin guide back into toc 18529da
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Update theming examples 2d2b12f
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Add Fanstatic tutorial 833536e
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Fix a couple of Sphinx includes da7e9d8
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Add draft notice to JavaScript tutorial 5c3ea40
@seanh seanh pushed a commit that referenced this issue Nov 27, 2013
Sean Hammond [#847] Move the versionchanged in the theming docs e7324b9
@seanh seanh pushed a commit that referenced this issue Nov 28, 2013
Sean Hammond [#847] Add note about undefined variables in Jinja d361dc8
@seanh seanh pushed a commit that referenced this issue Nov 28, 2013
Sean Hammond [#847] Delete a TODO in the docs 9972390
@seanh seanh pushed a commit that referenced this issue Nov 28, 2013
Sean Hammond [#847] Various tweaks to theming docs 0d6a0ec
@seanh seanh pushed a commit that referenced this issue Nov 28, 2013
Sean Hammond [#847] Add screenshots to templating tutorial a999af9
@seanh seanh pushed a commit that referenced this issue Nov 28, 2013
Sean Hammond [#847] Add screenshot to static files example 0dafeaf
@seanh seanh pushed a commit that referenced this issue Nov 28, 2013
Sean Hammond [#847] Add screenshots to CSS tutorial 116a9b9
@seanh seanh pushed a commit that referenced this issue Nov 28, 2013
Sean Hammond [#847] Add a seealso to theming docs index ea2a26a
@seanh seanh pushed a commit that referenced this issue Nov 28, 2013
Sean Hammond [#847] Various theming docs tweaks fdf72a0
@seanh seanh pushed a commit that referenced this issue Dec 9, 2013
Sean Hammond [#847] PEP-8 e21ca14
@seanh seanh pushed a commit that referenced this issue Dec 13, 2013
Sean Hammond [#847] Add template path explanation 9a75c9f
@seanh seanh pushed a commit that referenced this issue Dec 13, 2013
Sean Hammond [#847] Refactor a snippet from the theming docs
Also add snippets docstrings to best practices
66c79c4
@seanh seanh pushed a commit that referenced this issue Dec 13, 2013
Sean Hammond [#847] Add note that g is an alias for app_globals 751db71
@seanh seanh pushed a commit that referenced this issue Dec 13, 2013
Sean Hammond [#847] Add theming custom config setting example 839b5c8
@seanh seanh pushed a commit that referenced this issue Dec 13, 2013
Sean Hammond [#847] Delete a set_trace() dcf11d9
@seanh seanh pushed a commit that referenced this issue Dec 13, 2013
Sean Hammond [#847] Add docs for extensions custom config settings
And example with tests
86d90ee
@seanh seanh pushed a commit that referenced this issue Dec 13, 2013
Sean Hammond [#847] Add a factoriy for creating test sysadmins
..and use it in the example_iauthfunctions tests. Also use the normal
user factory in the tests.
f4a24ae
@seanh seanh pushed a commit that referenced this issue Dec 13, 2013
Sean Hammond [#847] Add syntax highlighting to literal includes a9d62f0
@seanh seanh pushed a commit that referenced this issue Dec 17, 2013
Sean Hammond [#847] Add some links to some CSS tools d065a57
@seanh seanh pushed a commit that referenced this issue Dec 17, 2013
Sean Hammond [#847] Remove a todo from the docs 73ec917
@seanh seanh pushed a commit that referenced this issue Dec 18, 2013
Sean Hammond [#847] PEP8 6905280
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment