From 6173522f8e6e1121a2eea8c66e4cfce970b0f4ec Mon Sep 17 00:00:00 2001 From: Noe-Sanchez Date: Sun, 28 Jan 2024 03:23:05 -0600 Subject: [PATCH] Info update, placeholders --- .github/workflows/{blank.yml => deploy.yml} | 2 +- README.md | 5 +- doc/aeroestructuras/aeroestructuras.rst | 4 ++ doc/another-feature.md | 51 --------------------- doc/avionica/avionica.rst | 4 ++ doc/conf.py | 6 +-- doc/index.rst | 15 +++--- doc/make.bat | 7 +-- doc/payload/payload.rst | 4 ++ doc/propulsion/propulsion.rst | 4 ++ doc/some-feature.md | 14 ------ src/README.md | 1 - 12 files changed, 32 insertions(+), 85 deletions(-) rename .github/workflows/{blank.yml => deploy.yml} (94%) create mode 100644 doc/aeroestructuras/aeroestructuras.rst delete mode 100644 doc/another-feature.md create mode 100644 doc/avionica/avionica.rst create mode 100644 doc/payload/payload.rst create mode 100644 doc/propulsion/propulsion.rst delete mode 100644 doc/some-feature.md delete mode 100644 src/README.md diff --git a/.github/workflows/blank.yml b/.github/workflows/deploy.yml similarity index 94% rename from .github/workflows/blank.yml rename to .github/workflows/deploy.yml index f98f6ba..05d7218 100644 --- a/.github/workflows/blank.yml +++ b/.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 index 16f870d..d1f2462 100644 --- 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 \ No newline at end of file diff --git a/doc/aeroestructuras/aeroestructuras.rst b/doc/aeroestructuras/aeroestructuras.rst new file mode 100644 index 0000000..feff72f --- /dev/null +++ b/doc/aeroestructuras/aeroestructuras.rst @@ -0,0 +1,4 @@ +Aeroestructuras +=============== + +Aquí va la doc de aeroestructuras \ No newline at end of file diff --git a/doc/another-feature.md b/doc/another-feature.md deleted file mode 100644 index 28125ea..0000000 --- a/doc/another-feature.md +++ /dev/null @@ -1,51 +0,0 @@ -# More features here - - -## Some text - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod -tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, -quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo -consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse -cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non -proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - - -## Table - -| No. | Prime | -| ---- | ------ | -| 1 | No | -| 2 | Yes | -| 3 | Yes | -| 4 | No | - - - -## Code blocks - -The following is a Python code block: -```python - def hello(): - print("Hello world") -``` - -And this is a C code block: -```c -#include -int main() -{ - printf("Hello, World!"); - return 0; -} -``` - - -## Math - -This creates an equation: -```{math} -a^2 + b^2 = c^2 -``` - -This is an in-line equation, {math}`a^2 + b^2 = c^2`, embedded in text. diff --git a/doc/avionica/avionica.rst b/doc/avionica/avionica.rst new file mode 100644 index 0000000..e19afb5 --- /dev/null +++ b/doc/avionica/avionica.rst @@ -0,0 +1,4 @@ +Avionica +========= + +Aquí va la doc de avionica \ No newline at end of file diff --git a/doc/conf.py b/doc/conf.py index 7bf72f5..09da54e 100644 --- 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 index a3c60e0..5889dfa 100644 --- 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 index 32bb245..582f37d 100644 --- 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 new file mode 100644 index 0000000..0be2105 --- /dev/null +++ b/doc/payload/payload.rst @@ -0,0 +1,4 @@ +Payload +======== + +Aquí va la doc de payload \ No newline at end of file diff --git a/doc/propulsion/propulsion.rst b/doc/propulsion/propulsion.rst new file mode 100644 index 0000000..cdea26c --- /dev/null +++ b/doc/propulsion/propulsion.rst @@ -0,0 +1,4 @@ +Propulsion +========== + +Aquí va la doc de propulsion \ No newline at end of file diff --git a/doc/some-feature.md b/doc/some-feature.md deleted file mode 100644 index cd6ac9f..0000000 --- a/doc/some-feature.md +++ /dev/null @@ -1,14 +0,0 @@ -# Some feature - -## Subsection - -Exciting documentation in here. -Let's make a list (empty surrounding lines required): - -- item 1 - - - nested item 1 - - nested item 2 - -- item 2 -- item 3 diff --git a/src/README.md b/src/README.md deleted file mode 100644 index 7bd5761..0000000 --- a/src/README.md +++ /dev/null @@ -1 +0,0 @@ -Here can be the source code files for your project ...