Add files

python/docs/source/detailed/common_doc_nav.incl

@@ -0,0 +1,4 @@
+quick nav links:
+
+* jump to :ref:`👩‍🔧 Detailed`
+* jump to :ref:`🔦 Tutorials`

python/docs/source/detailed/configs.rst

@@ -0,0 +1,30 @@
+🎛 Configurations for algorithms, trackers, endgames, etc
+===================================================================
+
+.. include:: common_doc_nav.incl
+
+🛤 Tracking configs
+---------------------------
+
+* :class:`pybertini.tracking.config.SteppingConfig`
+* :class:`pybertini.tracking.config.NewtonConfig`
+* :class:`pybertini.tracking.config.AMPConfig`
+* :class:`pybertini.tracking.config.FixedPrecisionConfig`
+
+.. autoclass:: pybertini.tracking.config.SteppingConfig
+
+.. autoclass:: pybertini.tracking.config.NewtonConfig
+
+.. autoclass:: pybertini.tracking.config.AMPConfig
+
+.. autoclass:: pybertini.tracking.config.FixedPrecisionConfig
+
+
+🎮 Endgame configs
+-------------------------
+
+.. autoclass:: pybertini.endgame.config.Endgame
+
+Algorithm configs
+---------------------------
+

python/docs/source/detailed/containers.rst

@@ -0,0 +1,15 @@
+🕳 pybertini.list
+=====================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+These types are exposed to Python, because they are returned types from some function or another.  They should be fully interoperable with regular lists, except they can't contain arbitrary things.  
+
+
+Auto-generated docs
+--------------------
+
+.. automodule:: pybertini.list

python/docs/source/detailed/cpp_side.rst

@@ -0,0 +1,31 @@
+🗡 C++-flavored gory-detail documentation
+===============================================
+
+.. include:: common_doc_nav.incl
+
+_pybertini
+-------------------
+
+.. automodule:: _pybertini
+
+
+_pybertini.function_tree
+----------------------------
+
+.. automodule:: _pybertini.function_tree
+
+
+
+_pybertini.tracking
+----------------------
+
+.. automodule:: _pybertini.tracking
+
+
+
+_pybertini.endgames
+----------------------
+
+.. automodule:: _pybertini.endgame
+
+

python/docs/source/detailed/detailed.rst

@@ -0,0 +1,49 @@
+👩‍🔧 Detailed
+*******************
+
+.. include:: common_doc_nav.incl
+
+This is a stub page, which merely acts to point you to more specific places in the documentation.  Table of contents below 🔽.  
+
+🖍 Highlights
+--------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   configs
+
+⚙️ Modules
+-------------
+
+.. toctree::
+   :maxdepth: 1
+
+   top_level
+   doubleprec
+   multiprec
+   function_tree
+   system
+   start_system
+   tracking
+   endgame
+   parse
+   containers
+   logging
+   
+
+🎱 Things you probably don't need
+----------------------------------------
+
+.. toctree::
+  :maxdepth: 1
+
+  cpp_side
+  🕸 PyBertini doc archives <https://doc.bertini2.org/pybertini_archives>
+
+
+
+
+
+
+

python/docs/source/detailed/doubleprec.rst

@@ -0,0 +1,12 @@
+2️⃣ pybertini.doubleprec
+==============================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+Auto-generated docs
+--------------------
+
+.. automodule:: pybertini.doubleprec

python/docs/source/detailed/endgame.rst

@@ -0,0 +1,21 @@
+🎮 pybertini.endgame
+==========================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+Auto-generated docs
+--------------------
+
+
+.. automodule:: pybertini.endgame
+
+
+🎮 pybertini.endgame.config
+=====================================
+
+.. automodule:: pybertini.endgame.config
+
+

python/docs/source/detailed/function_tree.rst

@@ -0,0 +1,26 @@
+🌳 pybertini.function_tree
+===================================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+Auto-generated docs
+--------------------
+
+.. automodule:: pybertini.function_tree
+   :members:
+
+🌳 pybertini.function_tree.symbol
+======================================
+
+.. automodule:: pybertini.function_tree.symbol
+   :members:
+
+
+🌳 pybertini.function_tree.root
+==================================
+
+.. automodule:: pybertini.function_tree.root
+   :members:

python/docs/source/detailed/logging.rst

@@ -0,0 +1,18 @@
+📋 pybertini.logging
+=====================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+Logging is enabled for PyBertini through Bertini2's core logging facilities, in turn powered by Boost.Log.  
+
+They currently aren't fancy, but you have a few things you can do.
+
+#. Adjust the level.  See :class:`~pybertini.logging.severity_level` and :func:`~pybertini.logging.set_level`
+
+Auto-generated docs
+--------------------
+
+.. automodule:: pybertini.logging

python/docs/source/detailed/multiprec.rst

@@ -0,0 +1,12 @@
+🃏 pybertini.multiprec
+============================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+Auto-generated docs
+--------------------
+
+.. automodule:: pybertini.multiprec

python/docs/source/detailed/parse.rst

@@ -0,0 +1,12 @@
+💬 pybertini.parse
+=====================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+Auto-generated docs
+--------------------
+
+.. automodule:: pybertini.parse

python/docs/source/detailed/start_system.rst

@@ -0,0 +1,12 @@
+🚦 pybertini.system.start_system
+==================================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+Auto-generated docs
+--------------------
+
+.. automodule:: pybertini.system.start_system

python/docs/source/detailed/system.rst

@@ -0,0 +1,12 @@
+🏙 pybertini.system
+==========================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+Auto-generated docs
+--------------------
+
+.. automodule:: pybertini.system

python/docs/source/detailed/top_level.rst

@@ -0,0 +1,29 @@
+🔝 pybertini
+==================
+
+.. include:: common_doc_nav.incl
+
+Namespaces
+-------------
+
+* :py:mod:`~pybertini.multiprec`
+* :py:mod:`~pybertini.system`
+* :py:mod:`~pybertini.function_tree`
+* :py:mod:`~pybertini.tracking`
+* :py:mod:`~pybertini.endgame`
+
+
+
+Convenience
+------------
+
+For your convenience, these things have been placed in the root level `pybertini` namespace:
+
+* :class:`~pybertini.system.System`
+* :class:`~pybertini.function_tree.symbol.Variable`
+* :class:`~pybertini.function_tree.VariableGroup`
+
+There's not a whole lot else at this level.  Pybertini mostly exists in submodules, to help things be organized.
+
+
+

python/docs/source/detailed/tracking.rst

@@ -0,0 +1,54 @@
+🛤 pybertini.tracking
+===========================
+
+.. include:: common_doc_nav.incl
+
+Notes
+--------
+
+Trackers in Bertini2 are stateful objects, that refer to a system they are tracking, hold their specific settings, and have a notion of current time and space value.
+
+Here are some particular classes and functions to pay attention to:
+
+* :class:`pybertini.tracking.AMPTracker`
+* :class:`pybertini.tracking.DoublePrecisionTracker`
+* :class:`pybertini.tracking.MultiplePrecisionTracker`
+
+Here are the implemented ODE predictors you can choose from:
+
+* :class:`pybertini.tracking.Predictor`
+
+Calls to :meth:`track_path` return a :class:`pybertini.tracking.SuccessCode`.
+
+And, trackers are implemented using observer pattern.  They live in the ``pybertini.tracking.observers`` namespace, with provisions for each tracker type available under a submodule thereof: ``amp``, ``multiple``, and ``double``.  They are also conveniently available using the ``tr.observers``, where ``tr`` is a tracker you already made.  See :mod:`pybertini.tracking.observers.amp`
+
+
+Auto-generated docs
+--------------------
+
+.. automodule:: pybertini.tracking
+
+
+🛤 pybertini.tracking.config
+=====================================
+
+.. automodule:: pybertini.tracking.config
+
+
+🛤 pybertini.tracking.observers
+===================================
+
+📝 All of these are available for all trackers, though you should use the ones for your tracker type.  Look in ``pybertini.tracking.AMPTracker.observers``, etc.
+
+.. automodule:: pybertini.tracking.observers
+
+#. ``pybertini.tracking.observers.amp``
+#. ``pybertini.tracking.observers.double``
+#. ``pybertini.tracking.observers.multiple``
+
+📝 Symmetrically, there are the same observers in all three.
+
+.. automodule:: pybertini.tracking.observers.amp
+
+
+ Know that you are loved and appreciated, dear reader.  💟