diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..378eac2 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ba501f6 --- /dev/null +++ b/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/README.md b/README.md deleted file mode 100644 index 65fb4dd..0000000 --- a/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Normativa para velocistas -La categoría de velocistas consiste en una prueba de velocidad en la que los robots deberán recorrer un circuito de forma autónoma en el menor tiempo posible. - -

- -# Índice - - - [Robots y homologación](robots.md) - - [Circuito](circuito.md) - - [Competición](competicion.md) - - -# Atribuciones - -Esta normativa se basa en el trabajo previo de otras competiciones de robots velocistas afines, tales como la [OSHWDem](https://oshwdem.org/), [Granabot](http://www.granabot.es/), [Malakabot](http://malakabot.com/), [Robolid](http://robolid.es/) y [LNRC](http://lnrc.es/). - -# Contribuidores - - - [AlejandraSaku](https://github.com/AlejandraSaku) - - [JavierIH](https://github.com/JavierIH) - - [Resaj](https://github.com/Resaj) - -# Recursos de interés - - - [Lista de robots velocistas Open Source](https://open-robosports.github.io/kits/velocistas/) - - [Generador de circuitos de velocistas en Octave](https://github.com/Resaj/basic-circuit-maker) - -# Licencia - -

diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8b2469e --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinxcontrib-ghcontributors diff --git a/circuito.md b/source/circuito.rst similarity index 96% rename from circuito.md rename to source/circuito.rst index 796bcf0..2d546b5 100644 --- a/circuito.md +++ b/source/circuito.rst @@ -1,4 +1,5 @@ -# Circuito +Circuito +======== El circuito consiste en una lona blanca de PVC con una o dos líneas negras que indican la trayectoria que debe seguir el robot. Estas líneas al mismo tiempo se utilizarán como guías que el robot podrá leer para conocer su posición. La utilización de una o dos líneas en el trazado y del sentido de giro quedan a elección de la organización del evento, pudiendo no desvelarse hasta el día de la competición. @@ -14,4 +15,6 @@ La superficie de la pista podrá presentar pequeñas irregularidades, aunque se A continuación se muestra un trazado de ejemplo para una competición de velocistas: -

+.. figure:: images/circuito_ejemplo.jpg + :width: 900 + :align: center diff --git a/competicion.md b/source/competicion.rst similarity index 97% rename from competicion.md rename to source/competicion.rst index a994b08..75f699a 100644 --- a/competicion.md +++ b/source/competicion.rst @@ -1,4 +1,5 @@ -# Desarrollo de la prueba +Desarrollo de la prueba +======================= Todos los robots deberán presentarse antes de la competición para su verificación. Una vez verificados, los robots se pondrán en parque cerrado y no se permitirá modificar ni el hardware ni el sofware del robot, salvo en casos excepcionales y bajo la aprobación de los jueces de la competición. @@ -6,7 +7,8 @@ Sí están permitidas las tareas de mantenimiento como la limpieza de los neumá La prueba se desarrollará en dos fases: clasificación y eliminatorias. -## Fase de clasificación +Fase de clasificación +--------------------- Los robots competirán individualmente en **2 intentos** de **1 vuelta** cronometrada al circuito. Solo se tendrá en cuenta el tiempo de la vuelta más rápida para la clasificación y no se permite reprogramar el robot entre intentos. @@ -22,7 +24,8 @@ Se clasificarán los 4, 8 o 16 robots con mejor tiempo, a elección de la organi IMPORTANTE: En eventos con tiempo limitado, se podrá prescindir de la fase clasificatoria y pasar directamente a la fase eliminatoria con todos los robots participantes. En ese caso, los robots con más puntos en el ranking de la ORS se considerarán los primeros de la clasificación. -## Fase eliminatoria +Fase eliminatoria +----------------- Los robots clasificados competirán en parejas en rondas eliminatorias, uno contra uno. Los cruces se realizarán siguiendo la clasificación de la fase anterior, de tal forma que el primero competirá contra el último, el segundo contra el penúltimo, etc. Y en caso de que queden puestos vacantes en los cruces o que se produzca algún abandono, el robot que quede sin rival en su enfrentamiento pasará automáticamente a la siguiente ronda eliminatoria. diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..0651ab5 --- /dev/null +++ b/source/conf.py @@ -0,0 +1,186 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'Normativa Velocistas' +copyright = '2019, Open RoboSports' +author = 'Open RoboSports' + +# The full version, including alpha/beta/rc tags +release = '0.1.0' +# The short X.Y version +version = release.split('-')[0] + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.mathjax', + 'sphinxcontrib.ghcontributors', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'es' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + 'logo': 'logo.jpg', + 'github_banner': 'true', + 'github_user': 'open-robosports', + 'github_repo': 'normativa-velocistas', + 'github_type': 'star', + 'github_count': 'true', +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['images'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'NormativaVelocistasdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'NormativaVelocistas.tex', 'Normativa Velocistas Documentation', + 'Open RoboSports', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'normativavelocistas', 'Normativa Velocistas Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'NormativaVelocistas', 'Normativa Velocistas Documentation', + author, 'NormativaVelocistas', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- diff --git a/images/by-sa.png b/source/images/by-sa.png similarity index 100% rename from images/by-sa.png rename to source/images/by-sa.png diff --git a/images/circuito_ejemplo.jpg b/source/images/circuito_ejemplo.jpg similarity index 100% rename from images/circuito_ejemplo.jpg rename to source/images/circuito_ejemplo.jpg diff --git a/images/competicion.png b/source/images/competicion.png similarity index 100% rename from images/competicion.png rename to source/images/competicion.png diff --git a/source/images/logo.jpg b/source/images/logo.jpg new file mode 100644 index 0000000..f166761 Binary files /dev/null and b/source/images/logo.jpg differ diff --git a/images/longitudyanchura.png b/source/images/longitudyanchura.png similarity index 100% rename from images/longitudyanchura.png rename to source/images/longitudyanchura.png diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..c80e985 --- /dev/null +++ b/source/index.rst @@ -0,0 +1,45 @@ +Normativa para velocistas - |version| +===================================== +La categoría de velocistas consiste en una prueba de velocidad en la que los robots deberán recorrer un circuito de forma autónoma en el menor tiempo posible. + +.. figure:: images/competicion.png + :width: 400 + :align: center + + +Índice +------ + +.. toctree:: + :maxdepth: 2 + + robots.rst + circuito.rst + competicion.rst + + + +Atribuciones +------------ + +Esta normativa se basa en el trabajo previo de otras competiciones de robots velocistas afines, tales como la `OSHWDem `_, `Granabot `_, `Malakabot `_, `Robolid `_ y `LNRC `_. + +Contribuidores +-------------- + +.. ghcontributors:: + :owner: open-robosports + :repository: normativa-velocistas + +Recursos de interés +------------------- + +- `Lista de robots velocistas Open Source `_ +- `Generador de circuitos de velocistas en Octave `_ + + Licencia + -------- + + .. figure:: images/by-sa.png + :width: 200 + :align: center diff --git a/robots.md b/source/robots.rst similarity index 96% rename from robots.md rename to source/robots.rst index de77245..3eeb1b7 100644 --- a/robots.md +++ b/source/robots.rst @@ -1,11 +1,14 @@ -# Robots +Robots +====== Los robots deben ser capaces de desplazarse por el circuito siguiendo una línea marcada en la superficie. En cuanto a su estructura, deberán cumplir una serie de requisitos de tamaño y peso para poder homologar. Estos requisitos se refieren al robot en estado completo de marcha (con ruedas, baterías... etc), siendo importante que se cumplan durante todo el desarrollo de la prueba. El peso máximo de los robots será inferior o igual a **2 kg**. Las medidas máximas de los velocistas no deberán superar en ningún caso los **30 cm** de largo, **20 cm** de ancho y **13 cm** de alto. Para asegurar que se cumplen estas medidas podrá emplearse un cajón de verificaciones en el que se deberán introducir los robots antes de competir. En la siguiente figura se muestra cómo debe ser medido un velocista. -

+.. figure:: images/longitudyanchura.png + :width: 500 + :align: center El funcionamiento de los velocistas debe ser autónomo, tanto en su sistema de control y su alimentación, y estará integrado en el propio robot.