Info update, placeholders

MTY-RocketLab · Jan 28, 2024 · 6173522 · 6173522
1 parent 242c6e3
commit 6173522
Show file tree

Hide file tree

Showing 12 changed files with 32 additions and 85 deletions.
diff --git a/.github/workflows/blank.yml → .github/workflows/deploy.yml b/.github/workflows/blank.yml → .github/workflows/deploy.yml
@@ -1,4 +1,4 @@
-name: documentation
+name: Deploy documentation to GitHub Pages
 
 on: [push, pull_request, workflow_dispatch]
 

diff --git a/README.md b/README.md
@@ -1,4 +1,3 @@
-# Documentation example
+# Documentación General MRL
 
-We use this example in the lesson
-[How to document your research software](https://coderefinery.github.io/documentation/).
+Hosteada en Github Pages, hecha con Sphinx y Read The Docs
diff --git a/doc/aeroestructuras/aeroestructuras.rst b/doc/aeroestructuras/aeroestructuras.rst
@@ -0,0 +1,4 @@
+Aeroestructuras
+===============
+
+Aquí va la doc de aeroestructuras
diff --git a/doc/another-feature.md b/doc/another-feature.md
diff --git a/doc/avionica/avionica.rst b/doc/avionica/avionica.rst
@@ -0,0 +1,4 @@
+Avionica
+=========
+
+Aquí va la doc de avionica
diff --git a/doc/conf.py b/doc/conf.py
@@ -15,7 +15,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['myst_parser']
+extensions = ['myst_parser', 'sphinx_rtd_theme',]
 
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
@@ -24,5 +24,5 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
+html_theme = "sphinx_rtd_theme"
+html_static_path = []
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,14 +1,11 @@
-.. Example documentation master file, created by
-   sphinx-quickstart on Sat Sep 23 20:35:12 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to Example's documentation!
+Documentación MRL
 ===================================
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Indice:
 
-   some-feature.md
-   another-feature.md
+   avionica/avionica
+   aeroestructuras/aeroestructuras
+   propulsion/propulsion
+   payload/payload
diff --git a/doc/make.bat b/doc/make.bat
@@ -4,9 +4,10 @@ pushd %~dp0
 
 REM Command file for Sphinx documentation
 
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
+:: if "%SPHINXBUILD%" == "" (
+:: 	set SPHINXBUILD=sphinx-build
+:: )
+
 set SOURCEDIR=.
 set BUILDDIR=_build
 

diff --git a/doc/payload/payload.rst b/doc/payload/payload.rst
@@ -0,0 +1,4 @@
+Payload
+========
+
+Aquí va la doc de payload
diff --git a/doc/propulsion/propulsion.rst b/doc/propulsion/propulsion.rst
@@ -0,0 +1,4 @@
+Propulsion
+==========
+
+Aquí va la doc de propulsion
diff --git a/doc/some-feature.md b/doc/some-feature.md
diff --git a/src/README.md b/src/README.md