Merge pull request #10 from kc611/rtd-docs

Added read the docs skeleton

.readthedocs.yml

@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "miniconda-latest"
+
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: true
+
+conda:
+  environment: docs/environment.yml

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/environment.yml

@@ -0,0 +1,10 @@
+name: pixie-docs
+channels:
+  - defaults
+
+dependencies:
+  - python=3.12
+  - pip
+  - setuptools
+  - sphinx
+  - sphinx-rtd-theme

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
+
+%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

docs/source/conf.py

@@ -0,0 +1,33 @@
+# 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
+import sys
+from os.path import dirname, join
+
+sys.path.insert(0, join(dirname(__file__), ".."))
+from pixie._version import get_versions
+
+project = 'pixie'
+copyright = '2024, Numba Developers'
+author = 'Numba Developers'
+release = get_versions()['version']
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+language = 'English'
+
+# -- 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']

docs/source/contributing.rst

@@ -0,0 +1,3 @@
+=======================
+Contributing Guidelines
+=======================

docs/source/faqs.rst

@@ -0,0 +1,3 @@
+====
+FAQs
+====

docs/source/index.rst

@@ -0,0 +1,19 @@
+.. pixie documentation master file, created by
+   sphinx-quickstart on Thu May 23 12:52:36 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+=================================
+Welcome to pixie's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   user_guide/index.rst
+   tutorials/index.rst
+   reference/index.rst   
+   faqs
+   contributing
+   release_notes

docs/source/reference/index.rst

@@ -0,0 +1,4 @@
+Reference Manual
+================
+
+.. toctree::

docs/source/release_notes.rst

@@ -0,0 +1,3 @@
+=============
+Release Notes
+=============

docs/source/tutorials/getting_started.rst

@@ -0,0 +1,3 @@
+===============
+Getting Started
+===============

docs/source/tutorials/index.rst

@@ -0,0 +1,6 @@
+Tutorials
+=========
+
+.. toctree::
+
+   getting_started.rst

docs/source/user_guide/index.rst

@@ -0,0 +1,6 @@
+User Guide
+==========
+
+.. toctree::
+
+   install.rst

docs/source/user_guide/install.rst

@@ -0,0 +1,4 @@
+======================
+Setup and Installation
+======================
+