New Sphinx-based web site deployed

59 views
Skip to first unread message

Stein Magnus Jodal

unread,
Oct 8, 2012, 6:28:13 PM10/8/12
to Buster.JS development
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

Christian Johansen

unread,
Oct 9, 2012, 4:54:35 AM10/9/12
to Stein Magnus Jodal, Buster.JS development
*applause*

Well done, Stein Magnus, thanks for your effort on this! :)
--
MVH
Christian

Fábio M. Costa

unread,
Oct 9, 2012, 11:52:52 AM10/9/12
to Stein Magnus Jodal, Buster.JS development
Wow this is a really big step!
Thanks for that, the site looks great and, as you said, it's now easier to maintain and add new documentation.

--
Fábio Miranda Costa
Front-end @ Yipit.com
twitter: @fabiomiranda
github: fabiomcosta

f.k...@gmail.com

unread,
Oct 10, 2012, 10:53:57 AM10/10/12
to buster...@googlegroups.com
Sadly the brand new docs website is not working

404 Not Found


nginx/0.8.54

Fábio M. Costa

unread,
Oct 10, 2012, 10:56:50 AM10/10/12
to f.k...@gmail.com, buster...@googlegroups.com
Works fine here, went to busterjs.org and got redirected to the following link, which is fine.


Inline image 1


--
Fábio Miranda Costa
Front-end @ Yipit.com
twitter: @fabiomiranda
github: fabiomcosta



image.png

Stein Magnus Jodal

unread,
Oct 10, 2012, 2:22:38 PM10/10/12
to buster...@googlegroups.com
You're not exactly giving us much to work on here. What URL did you
get this error on? How did you get to that URL?

--
Stein Magnus Jodal
Reply all
Reply to author
Forward
0 new messages