Skip to content

Commit

Permalink
Updated docs with image on the start page, build instructions in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
voetberg committed Sep 25, 2023
1 parent 9e2b5cb commit 2adfc58
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ __pycache__/
# Distribution / packaging
.Python
build/
_build/
develop-eggs/
dist/
downloads/
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ Simulation library for very simple simulations to *benchmark* machine learning a
2. A very simple data set will have objects, patterns, and signals that are intuitively quanitifiable and will be fast to generate.
3. A very simple data set will be a great testing ground for new networks and for newcomers to practice with the technology.

## Documentation

#### Readthedocs link coming soon!!

#### To build
```
pip install sphinx
cd docs
make html
```

The folder `docs/_build/html` will be populated with the documentation. Navigate to `file:///<Path To DeepBench>/docs/_build/html/index.html` in any web browser to view.

## Requirements
* python = ">=3.8,<3.11,"
Expand Down
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
contain the root `toctree` directive.
Welcome to DeepBench's documentation!

.. image:: repository_support/DeepSkies_Logos_DeepBench.png
:width: 800
=====================================

.. toctree::
Expand All @@ -17,6 +20,9 @@ Welcome to DeepBench's documentation!
shapes
example

.. image:: repository_support/DeepBench.png
:width: 800

Indices and tables
==================

Expand Down

0 comments on commit 2adfc58

Please sign in to comment.