Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Comparing changes

Choose two branches to see what's changed or to start a new pull request. If you need to, you can also compare across forks.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also compare across forks.
...
Checking mergeability… Don't worry, you can still create the pull request.
  • 2 commits
  • 2 files changed
  • 0 commit comments
  • 1 contributor
Showing with 54 additions and 0 deletions.
  1. +53 −0 doc/builddocs.rst
  2. +1 −0  doc/index.rst
View
53 doc/builddocs.rst
@@ -0,0 +1,53 @@
+How to build the docs
+=====================
+
+catkin provides (and uses) some plugins to `Sphinx
+<http://sphinx.pocoo.org/>`_ to build documentation. These plugins can
+be used to provide a common look and feel to the generated documentation.
+
+The first time you want to build catkin-controlled documentation (including
+catkin's own documentation), you'll need to setup your environment.
+
+Setup
+-----
+
+#. Get ``catkin-sphinx``::
+
+ git clone git://github.com/ros/catkin-sphinx.git
+
+#. Build and install it::
+
+ cd catkin-sphinx
+ sudo python setup.py install
+
+#. Copy ``ros-theme`` to your Sphinx configuration directory::
+
+ cp -a theme/ros-theme ~/sphinx
+
+Now you can build documentation for projects that use the ``ros-theme``. For
+example, to build catkin's documentation::
+
+ git clone git://github.com/ros/catkin.git
+ cd catkin/doc
+ make html
+
+To build and upload a new version of catkin's documentation to `ros.org
+<http://ros.org/doc/fuerte/api/catkin/html/>`_, (this is specific
+to catkin itself, and requires that you have appropriate credentials
+configured)::
+
+ git clone git://github.com/ros/catkin.git
+ cd catkin/doc
+ make upload
+
+Usage
+-----
+
+To use the ``ros-theme`` in your own project's documentation, add the
+following line to your ``conf.py``::
+
+ extensions = extensions + ['catkin_sphinx.cmake', 'catkin_sphinx.ShLexer']
+
+ros-theme-enabled projects use the following ``html_theme_path`` setting::
+
+ html_theme_path = [os.path.join(os.path.expanduser('~'), 'sphinx'), 'themes']
View
1  doc/index.rst
@@ -26,6 +26,7 @@ Contents
:maxdepth: 1
walkthrough
+ builddocs
supposed
layout
macros

No commit comments for this range

Something went wrong with that request. Please try again.