Skip to content

Commit 62b42c9

Browse files
authored
Merge pull request #104 from marty1885/master
Finalize Sphinx docs
2 parents e6a32ad + 762e437 commit 62b42c9

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

docs/images/logov1_white.png

82.2 KB
Loading

docs/source/PythonBindings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ print(t)
3939
"""
4040
```
4141

42-
## Python binding
42+
## PyEtaler
4343
The offical Python binding - [PyEtaler](https://guthub.com/etaler/pyetaler) in currently work in progress. But we recomment using ROOT to bind from Python before PyEtaler leaves WIP.

docs/source/UsingWithClingROOT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Otherwise, loading the library can be simplifed:
3333
[cling]$ #include <Etaler/Etaler.hpp>
3434
```
3535
36-
The same solution works with ROOT too! By default ROOT is compiled with C++11 only. You'll need to compile your own version of ROOT with C++17 enabled (by using `cmake -Dcxx17=ON`). Or you'll need to down load a version with C++17 enabled. Like the one in [Arch Linux's repo](https://www.archlinux.org/packages/community/x86_64/root/)
36+
The same solution works with ROOT too! By default ROOT is compiled with C++11 only. You'll need to compile your own version of ROOT with C++17 enabled (by using `cmake -Dcxx17=ON`). Or you'll need to download a version with C++17 enabled. Like the one in [Arch Linux's repo](https://www.archlinux.org/packages/community/x86_64/root/)
3737
```c++
3838
> root
3939
------------------------------------------------------------

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,5 @@ def setup(app):
3636
pygments_style = 'sphinx'
3737
todo_include_todos = False
3838
htmlhelp_basename = 'etalerdoc'
39+
html_logo = '../images/logov1_white.png'
3940

docs/source/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
Welcome to Etaler's documentation!
77
==================================
88

9-
`Etaler`_ in an high-performance implementation of `Numenta`_'s HTM algorithms in C++.
9+
Etaler in an high-performance implementation of Numenta's HTM algorithms in C++.
1010
It is diesigned to be used in real world applications and research projects.
1111

1212
Etaler provides:
1313

1414
* HTM algorithms with modern API
1515
* A minimal cross-platform (CPU, GPU, etc..) Tensor implementation
1616

17-
Etaker requires a modern C++ compiler supporting C++17. The following C++ compilers are supported
17+
Etaler requires a modern C++ compiler supporting C++17. The following C++ compilers are supported
1818

1919
* On Windows, Visual C++2019 or better
20-
* On *nix systems, GCC 8.2 or a recent version of clang
20+
* On Unix systems, GCC 8.2 or a recent version of clang
2121

2222
Licensing
2323
==================================
@@ -36,7 +36,7 @@ Be aware that Numenta holds the rights to HTM related patents. And only allows f
3636

3737
.. toctree::
3838
:maxdepth: 2
39-
:caption: USAGE:
39+
:caption: USAGE
4040

4141
Introduction
4242
Tensor
@@ -61,5 +61,5 @@ Indices and tables
6161
* :ref:`modindex`
6262
* :ref:`search`
6363

64-
.. _Etaler:: https://github.com/etaler/Etaler
65-
.. _Numenta:: https://numenta.com/
64+
.. _Etaler: https://github.com/etaler/Etaler
65+
.. _Numenta: https://numenta.com/

0 commit comments

Comments
 (0)