Skip to content

Commit

Permalink
Initial docs generation
Browse files Browse the repository at this point in the history
  • Loading branch information
ppdebreuck committed Feb 18, 2021
1 parent 14fe3d2 commit ba36f9b
Show file tree
Hide file tree
Showing 86 changed files with 39,664 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -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 = .
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)
Binary file added docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/modnet.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/modnet.featurizers.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/_build/doctrees/modnet.matbench.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/modnet.model_presets.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/modnet.tests.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/modules.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/setup.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d39407075ab2d2b41f211ea198d3eba9
tags: 645f666f9bcd5a90fca523b33c5a78b7
14 changes: 14 additions & 0 deletions docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Welcome to modnet's documentation!
=======================================================

.. toctree:: modnet
:maxdepth: 2
:caption: Contents:



Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
21 changes: 21 additions & 0 deletions docs/_build/html/_sources/modnet.featurizers.presets.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
modnet.featurizers.presets package
==================================

Submodules
----------

modnet.featurizers.presets.debreuck\_2020 module
------------------------------------------------

.. automodule:: modnet.featurizers.presets.debreuck_2020
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: modnet.featurizers.presets
:members:
:undoc-members:
:show-inheritance:
37 changes: 37 additions & 0 deletions docs/_build/html/_sources/modnet.featurizers.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
modnet.featurizers package
==========================

Subpackages
-----------

.. toctree::
:maxdepth: 4

modnet.featurizers.presets

Submodules
----------

modnet.featurizers.featurizers module
-------------------------------------

.. automodule:: modnet.featurizers.featurizers
:members:
:undoc-members:
:show-inheritance:

modnet.featurizers.utils module
-------------------------------

.. automodule:: modnet.featurizers.utils
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: modnet.featurizers
:members:
:undoc-members:
:show-inheritance:
21 changes: 21 additions & 0 deletions docs/_build/html/_sources/modnet.matbench.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
modnet.matbench package
=======================

Submodules
----------

modnet.matbench.benchmark module
--------------------------------

.. automodule:: modnet.matbench.benchmark
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: modnet.matbench
:members:
:undoc-members:
:show-inheritance:
21 changes: 21 additions & 0 deletions docs/_build/html/_sources/modnet.model_presets.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
modnet.model\_presets package
=============================

Submodules
----------

modnet.model\_presets.presets module
------------------------------------

.. automodule:: modnet.model_presets.presets
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: modnet.model_presets
:members:
:undoc-members:
:show-inheritance:
64 changes: 64 additions & 0 deletions docs/_build/html/_sources/modnet.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
modnet package
==============

Subpackages
-----------

.. toctree::

modnet.featurizers
modnet.matbench
modnet.model_presets
modnet.tests

Submodules
----------

modnet.ext\_data module
-----------------------

.. automodule:: modnet.ext_data
:members:
:undoc-members:
:show-inheritance:

modnet.models module
--------------------

.. automodule:: modnet.models
:members:
:undoc-members:
:show-inheritance:

modnet.preprocessing module
---------------------------

.. automodule:: modnet.preprocessing
:members:
:undoc-members:
:show-inheritance:

modnet.sklearn module
---------------------

.. automodule:: modnet.sklearn
:members:
:undoc-members:
:show-inheritance:

modnet.utils module
-------------------

.. automodule:: modnet.utils
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: modnet
:members:
:undoc-members:
:show-inheritance:
61 changes: 61 additions & 0 deletions docs/_build/html/_sources/modnet.tests.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
modnet.tests package
====================

Submodules
----------

modnet.tests.conftest module
----------------------------

.. automodule:: modnet.tests.conftest
:members:
:undoc-members:
:show-inheritance:

modnet.tests.test\_benchmark module
-----------------------------------

.. automodule:: modnet.tests.test_benchmark
:members:
:undoc-members:
:show-inheritance:

modnet.tests.test\_ext\_data module
-----------------------------------

.. automodule:: modnet.tests.test_ext_data
:members:
:undoc-members:
:show-inheritance:

modnet.tests.test\_model module
-------------------------------

.. automodule:: modnet.tests.test_model
:members:
:undoc-members:
:show-inheritance:

modnet.tests.test\_preprocessing module
---------------------------------------

.. automodule:: modnet.tests.test_preprocessing
:members:
:undoc-members:
:show-inheritance:

modnet.tests.test\_sklearn module
---------------------------------

.. automodule:: modnet.tests.test_sklearn
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: modnet.tests
:members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions docs/_build/html/_sources/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
modnet
======

.. toctree::
:maxdepth: 4

modnet
setup
7 changes: 7 additions & 0 deletions docs/_build/html/_sources/setup.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
setup module
============

.. automodule:: setup
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit ba36f9b

Please sign in to comment.