Add sphinx configuration

Author: ipa-nhg

.gitignore

@@ -0,0 +1 @@
+_build/

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+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)

README.md

@@ -0,0 +1,11 @@
+# RosTooling.github.io
+
+This repository holds the source and configuration files used to generate the [RosTooling documentation](https://ipa320.github.io/RosTooling.github.io/) page.
+
+Dependencies for Build: 
+* [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
+* `sudo apt install python3-pip`
+* `pip install sphinx`
+* `sphinx-build -b html . _build`
+
+The last command will create a _build folder to contain the html implementation.

_config.yml

@@ -1 +1 @@
-theme: jekyll-theme-cayman
+theme: jekyll-theme-slate

conf.py

@@ -0,0 +1,27 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'RosTooling.github.io'
+copyright = '2024, Nadia Hammoudeh Garcia'
+author = 'Nadia Hammoudeh Garcia'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx_rtd_theme']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

index.rst

@@ -0,0 +1,37 @@
+.. RosTooling.github.io documentation master file, created by
+   sphinx-quickstart on Tue Nov  5 14:06:14 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+RosTooling.github.io documentation
+==================================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   main
+   docu/RosModelDescription
+   docu/ParametersAPI
+   docu/NewCommunicationObjects
+   docu/RosSystemModelDescription
+   docu/LearnRosModels
+   docu/CreateYourModel
+   docu/rossdl
+   docu/StaticCodeAnalyis
+   docu/ros2model
+   docu/LearnRosSystemModels
+   docu/LearnRosSystemModels2
+   docu/CodeGeneration
+   docu/SystemModelsVisualization
+   docu/Example_Turtlesim
+   docu/MobileBase_beginner
+   docu/Manipulation_advanced
+   docu/eclipse_issues
+   docu/RosTooling_issues
+   docu/Example_PubSub

README.rst renamed to main.rst

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd