Permalink
Browse files

First new Sphinx web prototype

  • Loading branch information...
jlblancoc committed Jul 18, 2018
1 parent a425ba4 commit 35834c67071420a2afca165b431339fe7456fc81
Showing with 8,962 additions and 67 deletions.
  1. +1 −1 doc/CMakeLists.txt
  2. +0 −20 doc/Makefile
  3. +10 −0 doc/README.md
  4. +0 −4 doc/_readme_directory_.txt
  5. +7 −0 doc/_static/bootstrap.min.js
  6. +28 −0 doc/_static/breathe.css
  7. BIN doc/_static/fonts/glyphicons-halflings-regular.eot
  8. +229 −0 doc/_static/fonts/glyphicons-halflings-regular.svg
  9. BIN doc/_static/fonts/glyphicons-halflings-regular.ttf
  10. BIN doc/_static/fonts/glyphicons-halflings-regular.woff
  11. BIN doc/_static/mrpt_header_h100.png
  12. +141 −0 doc/_templates/layout.html
  13. +55 −0 doc/_templates/search.html
  14. +3 −0 doc/api.rst
  15. +2 −0 doc/basic-bootstrap/README
  16. +206 −0 doc/basic-bootstrap/layout.html
  17. +2 −0 doc/basic-bootstrap/theme.conf
  18. +73 −0 doc/bootstrap/alerts.less
  19. +66 −0 doc/bootstrap/badges.less
  20. +50 −0 doc/bootstrap/bootstrap.less
  21. +26 −0 doc/bootstrap/breadcrumbs.less
  22. +243 −0 doc/bootstrap/button-groups.less
  23. +160 −0 doc/bootstrap/buttons.less
  24. +269 −0 doc/bootstrap/carousel.less
  25. +34 −0 doc/bootstrap/close.less
  26. +69 −0 doc/bootstrap/code.less
  27. +33 −0 doc/bootstrap/component-animations.less
  28. +214 −0 doc/bootstrap/dropdowns.less
  29. +574 −0 doc/bootstrap/forms.less
  30. +305 −0 doc/bootstrap/glyphicons.less
  31. +84 −0 doc/bootstrap/grid.less
  32. +166 −0 doc/bootstrap/input-groups.less
  33. +50 −0 doc/bootstrap/jumbotron.less
  34. +64 −0 doc/bootstrap/labels.less
  35. +124 −0 doc/bootstrap/list-group.less
  36. +61 −0 doc/bootstrap/media.less
  37. +39 −0 doc/bootstrap/mixins.less
  38. +14 −0 doc/bootstrap/mixins/alerts.less
  39. +8 −0 doc/bootstrap/mixins/background-variant.less
  40. +18 −0 doc/bootstrap/mixins/border-radius.less
  41. +52 −0 doc/bootstrap/mixins/buttons.less
  42. +7 −0 doc/bootstrap/mixins/center-block.less
  43. +22 −0 doc/bootstrap/mixins/clearfix.less
  44. +85 −0 doc/bootstrap/mixins/forms.less
  45. +59 −0 doc/bootstrap/mixins/gradients.less
  46. +91 −0 doc/bootstrap/mixins/grid-framework.less
  47. +122 −0 doc/bootstrap/mixins/grid.less
  48. +21 −0 doc/bootstrap/mixins/hide-text.less
  49. +33 −0 doc/bootstrap/mixins/image.less
  50. +12 −0 doc/bootstrap/mixins/labels.less
  51. +29 −0 doc/bootstrap/mixins/list-group.less
  52. +10 −0 doc/bootstrap/mixins/nav-divider.less
  53. +9 −0 doc/bootstrap/mixins/nav-vertical-align.less
  54. +8 −0 doc/bootstrap/mixins/opacity.less
  55. +23 −0 doc/bootstrap/mixins/pagination.less
  56. +24 −0 doc/bootstrap/mixins/panels.less
  57. +10 −0 doc/bootstrap/mixins/progress-bar.less
  58. +8 −0 doc/bootstrap/mixins/reset-filter.less
  59. +6 −0 doc/bootstrap/mixins/resize.less
  60. +15 −0 doc/bootstrap/mixins/responsive-visibility.less
  61. +10 −0 doc/bootstrap/mixins/size.less
  62. +9 −0 doc/bootstrap/mixins/tab-focus.less
  63. +28 −0 doc/bootstrap/mixins/table-row.less
  64. +8 −0 doc/bootstrap/mixins/text-emphasis.less
  65. +8 −0 doc/bootstrap/mixins/text-overflow.less
  66. +227 −0 doc/bootstrap/mixins/vendor-prefixes.less
  67. +150 −0 doc/bootstrap/modals.less
  68. +660 −0 doc/bootstrap/navbar.less
  69. +242 −0 doc/bootstrap/navs.less
  70. +427 −0 doc/bootstrap/normalize.less
  71. +54 −0 doc/bootstrap/pager.less
  72. +88 −0 doc/bootstrap/pagination.less
  73. +265 −0 doc/bootstrap/panels.less
  74. +135 −0 doc/bootstrap/popovers.less
  75. +107 −0 doc/bootstrap/print.less
  76. +87 −0 doc/bootstrap/progress-bars.less
  77. +35 −0 doc/bootstrap/responsive-embed.less
  78. +194 −0 doc/bootstrap/responsive-utilities.less
  79. +162 −0 doc/bootstrap/scaffolding.less
  80. +234 −0 doc/bootstrap/tables.less
  81. +273 −0 doc/bootstrap/theme.less
  82. +36 −0 doc/bootstrap/thumbnails.less
  83. +102 −0 doc/bootstrap/tooltip.less
  84. +302 −0 doc/bootstrap/type.less
  85. +55 −0 doc/bootstrap/utilities.less
  86. +861 −0 doc/bootstrap/variables.less
  87. +29 −0 doc/bootstrap/wells.less
  88. +3 −0 doc/compiling.rst
  89. +18 −6 doc/conf.py
  90. +10 −0 doc/contents.rst
  91. BIN doc/design_of_images/mrpt_logo.png
  92. +3 −0 doc/install.rst
  93. +0 −36 doc/make.bat
  94. +66 −0 doc/mrpt.less
@@ -43,7 +43,7 @@ if(DOXYGEN_EXECUTABLE)
# documentation_html
# --------------------------------
add_custom_target(documentation_html
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/build.py ${MRPT_VERSION}
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/build.py ${CMAKE_MRPT_FULL_VERSION}
COMMENT "Generating MRPT documentation (html)"
SOURCES build.py conf.py _templates/layout.html ${RST_FILES}
)

This file was deleted.

Oops, something went wrong.
@@ -0,0 +1,10 @@
The "doc" directory contains the MRPT documentation, based on the Sphinx +
Breathe system (new as of 2018).
Build with `make documentation_html`
Requisites:
* Doxygen: `sudo apt install doxygen`
* Breathe and Sphinx: `pip install breathe`
* VirtualEnv: `pip install virtualenv`
* lessc: `sudo npm install -g less`

This file was deleted.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -0,0 +1,28 @@
/* -- breathe specific styles ----------------------------------------------- */
/* So enum value descriptions are displayed inline to the item */
.breatheenumvalues li tt + p {
display: inline;
}
/* So parameter descriptions are displayed inline to the item */
.breatheparameterlist li tt + p {
display: inline;
}
.container .breathe-sectiondef {
width: inherit;
}
.github-btn {
border: 0;
overflow: hidden;
}
.jumbotron {
background-size: 100% 4px;
background-repeat: repeat-y;
color: white;
text-align: center;
}
Binary file not shown.

Large diffs are not rendered by default.

Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,141 @@
{% extends "!layout.html" %}
{% block extrahead %}
<meta name="description" content="Mobile Robot Programming Toolkit (MRPT)">
<meta name="keywords" content="C++, MRPT, library">
<meta name="author" content="Jose Luis Blanco-Clarco">
<link rel="stylesheet" href="_static/mrpt.css">
{# Google Analytics #}
<!-- TODO -->
{% endblock %}
{%- macro searchform(classes, button) %}
<form class="{{classes}}" role="search" action="{{ pathto('search') }}"
method="get">
<div class="form-group">
<input type="text" name="q" class="form-control"
{{ 'placeholder="Search"' if not button }} >
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
{% if button %}
<input type="submit" class="btn btn-default" value="search">
{% endif %}
</form>
{%- endmacro %}
{% block header %}
<nav class="navbar navbar-inverse">
<div class="tb-container">
<div class="row">
<div class="navbar-content">
{# Brand and toggle get grouped for better mobile display #}
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed"
data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">MRPT</a>
</div>
{# Collect the nav links, forms, and other content for toggling #}
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"
role="button" aria-expanded="false">{{ version }}
<span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
{% for v in versions.split(',') %}
<li><a href="//docs.mrpt.org/{{v}}">{{v}}</a></li>
{% endfor %}
</ul>
</li>
{% for name in ['Contents', 'Install', 'API'] %}
{% if pagename == name.lower() %}
<li class="active"><a href="{{name.lower()}}.html">{{name}}
<span class="sr-only">(current)</span></a></li>
{%else%}
<li><a href="{{name.lower()}}.html">{{name}}</a></li>
{%endif%}
{% endfor %}
</ul>
{% if pagename != 'search' %}
{{ searchform('navbar-form navbar-right', False) }}
{%endif%}
</div> {# /.navbar-collapse #}
</div> {# /.col-md-offset-2 #}
</div> {# /.row #}
</div> {# /.tb-container #}
</nav>
{% if pagename == "index" %}
{% set download_url = 'https://github.com/MRPT/mrpt/releases/download' %}
<div class="jumbotron">
<div class="tb-container">
<h1><img src="_static/mrpt_header_h100.png" alt="mrpt logo" height="100"/> MRPT</h1>
<p class="lead">Empowering C++ development in robotics</p>
<!--
<div class="btn-group" role="group">
<a class="btn btn-success"
href="{{download_url}}/{{version}}/mrpt-{{version}}.zip">
<span class="glyphicon glyphicon-download"></span> Download
</a>
<button type="button" class="btn btn-success dropdown-toggle"
data-toggle="dropdown"><span class="caret"></span></button>
<ul class="dropdown-menu">
{% for v in versions.split(',') %}
{% set name = 'fmt' if v.split('.')[0]|int >= 3 else 'cppformat' %}
<li><a href="{{download_url}}/{{v}}/{{name}}-{{v}}.zip">Version {{v}}
</a></li>
{% endfor %}
</ul>
</div> -->
</div>
</div>
{% endif %}
{% endblock %}
{# Disable relbars. #}
{% block relbar1 %}
{% endblock %}
{% block relbar2 %}
{% endblock %}
{% block content %}
<div class="tb-container">
<div class="row">
{# Sidebar is currently disabled.
<div class="bs-sidebar">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
{%- block sidebarlogo %}
{%- if logo %}
<p class="logo"><a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}"
alt="Logo"/>
</a></p>
{%- endif %}
{%- endblock %}
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
</div>
</div>
</div>
#}
<div class="content">
{% block body %} {% endblock %}
</div>
</div>
</div>
{% endblock %}
{% block footer %}
{{ super() }}
{# Placed at the end of the document so the pages load faster. #}
<script src="_static/bootstrap.min.js"></script>
{% endblock %}
@@ -0,0 +1,55 @@
{#
basic/search.html
~~~~~~~~~~~~~~~~~
Template for the search page.
:copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- extends "layout.html" %}
{% set title = _('Search') %}
{% set script_files = script_files + ['_static/searchtools.js'] %}
{% block extrahead %}
<script type="text/javascript">
jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
</script>
{# this is used when loading the search index using $.ajax fails,
such as on Chrome for documents on localhost #}
<script type="text/javascript" id="searchindexloader"></script>
{{ super() }}
{% endblock %}
{% block body %}
<h1 id="search-documentation">{{ _('Search') }}</h1>
<div id="fallback" class="admonition warning">
<script type="text/javascript">$('#fallback').hide();</script>
<p>
{% trans %}Please activate JavaScript to enable the search
functionality.{% endtrans %}
</p>
</div>
<p>
{% trans %}From here you can search these documents. Enter your search
words into the box below and click "search". Note that the search
function will automatically search for all of the words. Pages
containing fewer words won't appear in the result list.{% endtrans %}
</p>
{{ searchform('form-inline', True) }}
{% if search_performed %}
<h2>{{ _('Search Results') }}</h2>
{% if not search_results %}
<p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
{% endif %}
{% endif %}
<div id="search-results">
{% if search_results %}
<ul>
{% for href, caption, context in search_results %}
<li><a href="{{ pathto(item.href) }}">{{ caption }}</a>
<div class="context">{{ context|e }}</div>
</li>
{% endfor %}
</ul>
{% endif %}
</div>
{% endblock %}
@@ -0,0 +1,3 @@
########
API
########
@@ -0,0 +1,2 @@
Sphinx basic theme with Bootstrap support. Modifications are kept to
a minimum to simplify integration in case of changes to Sphinx theming.
Oops, something went wrong.

0 comments on commit 35834c6

Please sign in to comment.