Commit 665bc78d authored by David Hendriks's avatar David Hendriks
Browse files

updated docs

parent 8e40fb6b
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -51,4 +51,4 @@ Also: I figured that having binaryc output the log like "<LOG HEADER> t=10e4 ...

See examples/ dir for some working examples

When you try to `import binary_c_python_api` and python complains about it not existing, but you are sure that you correctly included the necessary pythonpaths, then you probably need to rebuild the package:
 No newline at end of file
When you try to `import binary_c_python_api` and python complains about it not existing, but you are sure that you correctly included the necessary pythonpaths, then you probably need to rebuild the package.
+1 −0
Original line number Diff line number Diff line
@@ -28,6 +28,7 @@ def autogen_C_logging_code(logging_dict, verbose=0):
                'model.dt'
            ]
        }
        
    """

    # Check if the input is of the correct form
+18 −0
Original line number Diff line number Diff line
@@ -13,6 +13,8 @@
import os
import sys

# https://www.sphinx-doc.org/en/1.5/ext/example_google.html

# Include paths for python code
sys.path.insert(0, os.path.abspath("."))
sys.path.insert(0, os.path.abspath("../../binarycpython"))
@@ -41,10 +43,26 @@ extensions = [
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.viewcode',
    'sphinx.ext.napoleon',
    "hawkmoth",
    "m2r",
]


# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True


source_suffix = [".rst", ".md"]

# Add any paths that contain templates here, relative to this directory.

docs/source/grid.rst

0 → 100644
+7 −0
Original line number Diff line number Diff line
grid\_class module
=================================

.. automodule:: grid
   :members:
   :undoc-members:
   :show-inheritance:
 No newline at end of file
+2 −1
Original line number Diff line number Diff line
@@ -6,4 +6,5 @@ binaryc_python_utils

   custom_logging_functions
   functions
.. stellar_types
   grid
   stellar_types