| Alexander Afanasyev | 508269a | 2012-07-28 13:59:54 -0700 | [diff] [blame] | 1 | .. ns3-theme documentation master file, created by |
| 2 | sphinx-quickstart on Fri Jun 15 12:53:37 2012. |
| 3 | You can adapt this file completely to your liking, but it should at least |
| 4 | contain the root `toctree` directive. |
| 5 | |
| 6 | |
| 7 | The files in this directory customize the Doxygen and Sphinx |
| 8 | layout and rendering to give a common look. |
| 9 | |
| 10 | |
| 11 | Design |
| 12 | ------ |
| 13 | |
| 14 | The basic color scheme is taken from the ns3 homepage, http://www.nsnam.org/ |
| 15 | |
| 16 | Since Sphinx provides more flexible layout and configuration control, |
| 17 | the Doxygen layout and images are used as the basis. |
| 18 | |
| 19 | The top bar design is derived from Doxygen's default when a logo, |
| 20 | project name and description are given in the Doxygen configuration file. |
| 21 | The files ``layout.html`` and ``ns3_doxy_header.html`` should kept in sync. |
| 22 | |
| 23 | |
| 24 | Sphinx Files |
| 25 | ------------ |
| 26 | |
| 27 | ``layout.html`` (:ref:`static filename <sphinx-static-filenames>`) |
| 28 | Augments the default page layout, including the top bar. |
| 29 | |
| 30 | ``theme.conf`` (:ref:`static filename <sphinx-static-filenames>`) |
| 31 | Configuration parameters for ``layout.html`` and ``default.css_t``. |
| 32 | |
| 33 | ``static/bc_s.png`` |
| 34 | Angle bracket in Sphinx relbar, taken from the Doxygen html output. |
| 35 | |
| 36 | ``static/default.css_t`` (:ref:`static filename <sphinx-static-filenames>`) |
| 37 | Default Sphinx CSS template, copied from the default theme. |
| 38 | |
| 39 | ``static/nav_f.png`` |
| 40 | Background image for headings, taken from the Doxygen html output. |
| 41 | |
| 42 | ``static/sidebar.js`` (:ref:`static filename <sphinx-static-filenames>`) |
| 43 | Sidebar script, copied from the default theme. |
| 44 | |
| 45 | ``static/tab_b.png`` |
| 46 | Background image for the Sphinx relbar, taken from the Doxygen html output. |
| 47 | |
| 48 | .. _sphinx-static-filenames: |
| 49 | .. note:: **Static Filenames** |
| 50 | |
| 51 | Sphinx uses hard-coded file names (and the ``static`` directory name). |
| 52 | The files referenced above can't be renamed. |
| 53 | |
| 54 | |
| 55 | Doxygen Files |
| 56 | ------------- |
| 57 | |
| 58 | ``ns3_doxy_footer.html`` |
| 59 | Defines the page footer. |
| 60 | |
| 61 | ``ns3_doxy_header.html`` |
| 62 | Defines the page header, including the top bar. |
| 63 | |
| 64 | ``static/doxygen.css`` |
| 65 | Default Doxygen CSS file, obtained by the ``doxygen -w html ...`` |
| 66 | command. |
| 67 | |
| 68 | Shared Files |
| 69 | ------------ |
| 70 | |
| 71 | ``README.rst`` |
| 72 | This file, not used by Doxygen or Sphinx. |
| 73 | |
| 74 | ``static/bar-top.png`` |
| 75 | Background image for the top bar, resized from the ns-3 homepage. |
| 76 | |
| 77 | ``static/favicon.ico`` |
| 78 | Browser location bar favicon, referenced in ``layout.html`` and |
| 79 | ``ns3_doxy_header.html``, taken from the ns-3 homepage. |
| 80 | |
| 81 | ``static/ns-3-inverted-notext-small.png`` |
| 82 | Logo used in the top bar, taken from the ns-3 media kit. |
| 83 | |
| 84 | ``static/ns3_stylesheet.css`` |
| 85 | Style customizations for both Doxygen and Sphinx. |