Better Documentation Website

[heinermann]

The Doxygen-generated documentation pages are insufficient. The following needs to be done:

• [x] Easier navigation (see https://code.google.com/p/bwapi/wiki/OldDocumentation vs http://bwapi.github.io/).
• [x] Less clutter from the styles and effects.
• [x] Reduce page load times because of styles and effects.
• [x] Bug in Doxygen causes some tree menu items to not function correctly.
• [x] Better search (currently must be an exact match from the beginning of the string).
• [ ] Shorten page URLs (i.e. http://bwapi.github.io/namespace_b_w_a_p_i_1_1_unit_types.html#ad4929b0d518de23e6de8465c628213d0 could be bwapi.github.io/BWAPI_UnitTypes.html#Protoss_Nexus).

Possible other desires:

• [ ] Locating example code from other bot sources (AIIDE sources, etc).

[heinermann]

Alternative is to use the doxygen twitter bootstrap with a custom theme.

Also note that URLs are deterministic, despite the hash name.

[heinermann]

Also see http://www.stack.nl/~dimitri/doxygen/manual/grouping.html . This allows us to group functions and classes together, i.e. in the old documentation, things were split into API and Types. In the Unit class, functions were split into methods and unit command. This can be done by using Doxygen's grouping feature.

[albertouri]

Maybe it's worth to consider to use Sphinx

1. You can use your current doxygen with Breathe
2. More good-looking themes
3. There are a lot of projects using Sphinx
4. We can use Read the Docs to host the documentations and it can be integrated with GitHub

[heinermann]

Thanks. Will investigate soon.

[heinermann]

Decided on m.css. I already have it working and it has reasonable search functionality.

Going to pass on shortening page URLs, simply because it seems like a pain to deal with and it will break existing links if it gets changed.