Merge pull request #2 from kesslerlib/newdocs

Documentation (new structure for jupyter notebooks)

Author: gbaydin

.gitignore

@@ -71,6 +71,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/source/_autosummary
 
 # PyBuilder
 .pybuilder/

docs/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     = 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)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,2 @@
+myst-nb==0.12.3
+.[docs]  # Install kessler from current directory

docs/Space_Debris_Low_Earth_Orbit.png …_static/Space_Debris_Low_Earth_Orbit.pngdocs/Space_Debris_Low_Earth_Orbit.png renamed to docs/source/_static/Space_Debris_Low_Earth_Orbit.png docs/Space_Debris_Low_Earth_Orbit.png renamed to docs/source/_static/Space_Debris_Low_Earth_Orbit.png

@@ -0,0 +1,17 @@
+@import url("theme.css");
+
+/* .wy-side-nav-search {
+  background-color: #ffffff;
+} */
+
+.wy-side-nav-search, .wy-nav-top {
+  background: #000000;
+}
+
+.wy-side-nav-search>a img.logo, .wy-side-nav-search .wy-dropdown>a img.logo {
+  max-width: 100%;
+}
+
+.wy-side-nav-search>div.version {
+  color: dimgray;
+}

docs/source/_static/favicon.ico

@@ -0,0 +1,2 @@
+{% extends "!layout.html" %}
+{% set css_files = css_files + ["_static/style.css"] %}

docs/kessler_logo.png docs/source/_static/kessler_logo.pngdocs/kessler_logo.png renamed to docs/source/_static/kessler_logo.png

@@ -0,0 +1,8 @@
+..
+   this file is used to make sure autosummary gets executed by the readthedocs.io runner
+
+.. autosummary::
+   :toctree: _autosummary
+   :recursive:
+
+   kessler