Initial documentation structure

This is a first commit of ReactiveX#270, to start structuring a documentation. For now it contains empty sections, and references to the existing APIs (observable, observer, subject, and operators).
MainRo · Jan 5, 2019 · 8fee9ae · 8fee9ae
1 parent fd70918
commit 8fee9ae
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 11 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -14,7 +14,7 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../rx'))
+sys.path.insert(0, os.path.abspath('../'))
 
 
 # -- Project information -----------------------------------------------------
@@ -24,9 +24,9 @@
 author = 'Dag Brattli'
 
 # The short X.Y version
-version = '2.0'
+version = '3.0'
 # The full version, including alpha/beta/rc tags
-release = '2.0.0-alpha1'
+release = '3.0.0-alpha1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/doc/get_started.rst b/doc/get_started.rst
@@ -0,0 +1,4 @@
+.. get_started
+
+Get Started
+============
diff --git a/doc/index.rst b/doc/index.rst
@@ -3,17 +3,19 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to RxPY's documentation!
-================================
+The Reactive Extensions for Python (RxPY)
+==========================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+RxPY is a library for composing asynchronous and event-based programs using
+observable collections and pipable query operators in Python.
 
-.. automodule:: rx.core
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
 
-.. autoclass:: ObservableBase
-    :members:
+    installation
+    get_started
+    reference
 
 Indices and tables
 ==================

diff --git a/doc/installation.rst b/doc/installation.rst
@@ -0,0 +1,4 @@
+.. Installation
+
+Installation
+=============
diff --git a/doc/reference.rst b/doc/reference.rst
@@ -0,0 +1,13 @@
+.. reference:
+
+Reference
+==========
+
+
+.. toctree::
+   :name: reference
+
+   Observable Factory <reference_observable>
+   Observer <reference_observer>
+   Subject <reference_subject>
+   Operators <reference_operators>
diff --git a/doc/reference_observable.rst b/doc/reference_observable.rst
@@ -0,0 +1,7 @@
+.. reference_observable:
+
+Observable Factory
+=====================
+
+.. automodule:: rx
+    :members:
diff --git a/doc/reference_observer.rst b/doc/reference_observer.rst
@@ -0,0 +1,7 @@
+.. reference_observer:
+
+Observer
+========
+
+.. autoclass:: rx.core.Observer
+    :members:
diff --git a/doc/reference_operators.rst b/doc/reference_operators.rst
@@ -0,0 +1,7 @@
+.. reference_operators:
+
+Operators
+=========
+
+.. automodule:: rx.operators
+    :members:
diff --git a/doc/reference_subject.rst b/doc/reference_subject.rst
@@ -0,0 +1,16 @@
+.. reference_subject:
+
+Subject
+========
+
+.. autoclass:: rx.subjects.Subject
+    :members:
+
+.. autoclass:: rx.subjects.BehaviorSubject
+    :members:
+
+.. autoclass:: rx.subjects.ReplaySubject
+    :members:
+
+.. autoclass:: rx.subjects.AsyncSubject
+    :members: