sphinx-contrib / feed / TODO.txt

=================================================================
TODO
=================================================================

- create tests to verify handling of relative *image* links
- package up this project for independent pypi download
- something is definitely not right with cleaning up the pickled doctree after
  a document is moved - it vanishes from the tree unless you rebuild. That is
  going to suck to write tests for
- improve and document the toctree-like "latest" directive

  - why are latest list entires marked as external references?
  - make *sorting* by date optional
  - how can i force updates when a child document of a toc overview is
    updated?
  - make *displaying* date optional
  - support custom date format when it *is* displayed
  - (blue sky) How about, then, supporting microformats for date display?
  - optionally, rather than ignoring undated articles, include them at the
    bottom of the list.
  - (Blue sky) support dates on links and subheadings rather than just whole
    documents (requires work with sphinx/docutils)
  - create tests of round-trip date parsing (Are the displayed dates the same
    as the supplied ones?
  - fix bug with recursive display - ATM if you explicitly include subdirs, it
    will explode when writing HTML in environment.collect_relations
  
    - testcase? Is this actually true, or was that a badly formatted site?

- not just a site feed but per-topic (per-subdirectory?) rss feeds

  - therefore provide markup for embedding such a per-topic rss feed at the
    appropriate place

- write rss at the new `html-collect-pages` event
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.