Hi all,
In the beginning of May, I believe, I pushed for using the Sphinx
documentation generator (
http://sphinx.pocoo.org/) for the Buster.JS
docs so that the docs maintenance would become easier, and we would
get rid of all the broken links. Since I pushed for it, I got the the
colorful documentation tzar hat with bells and whistles and
everything, and was asked to fix it myself.
After months with two docs repos that we've tried to keep in sync
while porting the docs from HTML to the Sphinx format
(reStructuredText + Sphinx additions), the job is now finally
complete.
The old buster-docs repo has been renamed to buster-docs-old, while
the new repo is now known as buster-docs. If you got a checkout of any
of these repos, remember to update your git remote.
On pushes to the new buster-docs repo on GitHub, the web site--now
hosted by Read The Docs (
http://www.readthedocs.org/)--is
automatically updated and made available at
http://docs.busterjs.org/
http://busterjs.org/ will redirect to
http://docs.busterjs.org/ for
now, but may become a flashy marketing page in the future.
The new repo got two branches:
- master got the docs for the latest release, currently v0.6.2, and
the HEAD of master can always be seen at
http://docs.busterjs.org/en/latest/
- develop got the docs for the next release, currently v0.7, and the
HEAD of develop can always be seen at
http://docs.busterjs.org/en/develop/
Builds of the documentation for release tags can also be made
available, so that a user stuck on an old version can get docs
specific for the version he's on.
I would like to thank Jesper Haug Karsrud for helping out with porting
the docs. Kudos! :-)
Now, we just need to write more/better/updated docs and get ready for
a magnificent v0.7. Pull requests are welcome!
--
Stein Magnus Jodal