Skip to content

Commit

Permalink
Tidied up the ToDo list and added a bit more info about using the med…
Browse files Browse the repository at this point in the history
…ia_dir.
  • Loading branch information
cmacmackin committed Jan 7, 2015
1 parent a549c4c commit 95f8395
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,10 @@ left blank then relative URLs will be used for links. (<em>default:</em> blank,
(<em>default:</em> ./doc)</strong></dd>
<dt>media_dir</dt><dd>A directory containing any images or other content which
you will use or link to in your documentation. This will be placed at the root
of your documentation file-tree, with the name "media".</dd>
of your documentation file-tree, with the name "media". To link to this
content from the index (i.e. from the description and summary provided in the
project file) you would use ``./media/<file-name>``, while it would be
``../media/<file-name>`` from anywhere else.</dd>
<dt>css</dt><dd>The path to a custom style-sheet which can be used to modify the
appearance of the output.</dd>
<dt>extensions</dt><dd>File extensions which will be read by FORD for
Expand Down Expand Up @@ -360,7 +363,7 @@ displayed in more cases in future. Recognized types of meta-data are:
fairly useless, just being printed in the documentation. In future, FORD may
provide lists of things in each category.</dd>
<dt>summary</dt><dd>A brief description of this part of the code. If not
specified then FORD will use the first paragraph of the body of your
specified, then FORD will use the first paragraph of the body of your
documentation.</dd>
<dt>deprecated</dt><dd>If this is present and not ``False`` then a
label saying "Deprecated" will be placed in the documentation.</dd>
Expand All @@ -377,7 +380,6 @@ things which I'd like to do at some point include:
- Add the ability to produce dependency diagrams and inheritance diagrams for
modules and types, respectively.
- Make more options configurable from the command-line.
- Add a search feature.
- Test on some more code, including that of other people, who may have different
coding styles.
- Add the ability to identify function calls and use this to work out
Expand All @@ -394,10 +396,6 @@ things which I'd like to do at some point include:
renaming module procedures when loading them.
- Improve the sidebar for source files so that it will link to the items that it
lists.
- Allow the user to provide a favicon.
- Provide a directory in which the user can place any images and/or other
media they want available.
- Use summaries of the description in some places.
- Improve the way procedures are handled as arguments. In particular, allow
any abstract interface which was used as a template to be visible somehow.

Expand Down

2 comments on commit 95f8395

@zbeekman
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@szaghi
Copy link
Member

@szaghi szaghi commented on 95f8395 Jan 7, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good good good!

Please sign in to comment.