Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #68

Merged
merged 43 commits into from
Apr 20, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
f35c0ed
Clean up notebook output.
jgosmann Feb 20, 2018
24d871a
Draft basic structure of documentation.
jgosmann Aug 9, 2017
25a88f8
Add rudimentary API documentation.
jgosmann Aug 9, 2017
5083c15
Add getting started section to documentation.
jgosmann Aug 9, 2017
518370f
Add general SPA description to documentation.
jgosmann Aug 9, 2017
a9fe2a6
Add section about structured representation to doc
jgosmann Aug 9, 2017
4007421
Start writing general Nengo SPA introduction.
jgosmann Aug 10, 2017
7fa17ea
Mark down some documentation todos.
jgosmann Aug 10, 2017
5922e50
Replace numpydoc with napoleon.
jgosmann Aug 10, 2017
ff67668
Add section about Spaun to documentation.
jgosmann Aug 10, 2017
e017660
Use nbsphinx to include notebooks in doc (WIP).
jgosmann Aug 11, 2017
d26170b
Update most examples.
Seanny123 Oct 26, 2017
175e260
Documented vocab.py
Seanny123 Nov 6, 2017
bec4ee5
Removed excessive paren
Seanny123 Nov 6, 2017
7bb5964
Fix typos in pointer.py
Seanny123 Nov 6, 2017
c5e78e6
documented adding input/output to network
Seanny123 Nov 7, 2017
69d36a5
first pass at documenting modules
Seanny123 Nov 8, 2017
2c6069d
fixed docs for identity ens arr
Seanny123 Nov 8, 2017
ca7c138
Updated notebook example syntax
Seanny123 Nov 9, 2017
e0f7ee8
Clarified AM example.
Seanny123 Feb 20, 2018
5f509c8
Updated examples to newest action syntax.
Seanny123 Feb 21, 2018
b6375c5
Write introduction to Nengo SPA.
jgosmann Feb 21, 2018
af8a4d4
Improved action plots.
Seanny123 Feb 23, 2018
e6f01b0
Document how to retrieve examples.
jgosmann Mar 1, 2018
dc88a31
Limit toctree depth.
jgosmann Mar 1, 2018
ad1e937
Setup basic API documentation structure.
jgosmann Mar 2, 2018
c91c7e0
Organizing and updating API documentation.
jgosmann Mar 9, 2018
a0d26d7
Finish documentation for nengo_spa.vocab.
jgosmann Mar 12, 2018
2d2da50
Update API documentation for networks.
jgosmann Mar 12, 2018
a762f6b
Update module API documentation.
jgosmann Mar 12, 2018
947f381
Final updates to examples.
jgosmann Mar 14, 2018
43d1783
Update license and its inclusion level in docs.
jgosmann Mar 14, 2018
d7b81be
Fix images in notebooks in doc.
jgosmann Mar 15, 2018
a720212
Added changes to changelog.
Seanny123 Mar 22, 2018
4baaf36
Added 'how to contribute' instructions.
Seanny123 Mar 22, 2018
a93b79c
Added custom module creation example.
Seanny123 Mar 23, 2018
edbfa36
Document the implementation approach of SPA syntax
jgosmann Apr 18, 2018
d6fc4e9
Define absorbing element precisely.
jgosmann Apr 18, 2018
323b2c2
Removed commented-out lines in conf.py
Seanny123 Apr 18, 2018
45d68ff
Fixed whitespace in modules.
Seanny123 Apr 18, 2018
ddb055b
Fixed typos and phrasing.
Seanny123 Apr 18, 2018
765798a
Exclude tests from installed packages.
jgosmann Apr 19, 2018
dd70b3e
Fix occasional test failure.
jgosmann Apr 20, 2018
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,19 @@ Release History
0.4.0 (unreleased)
==================

This release increases the minimum required Nengo version to Nengo 2.5
This release increases the minimum required Nengo version to Nengo 2.7
(previously Nengo 2.4).

**Added**

- Added documentation and build tools for the documentation.
(`#68 <https://github.com/nengo/nengo_spa/pull/68>`_)

**Remove**

- Unnecessary ``vocab`` argument from ``Transcode``.
(`#68 <https://github.com/nengo/nengo_spa/pull/68>`_)

**Fixed**

- Validation of ``VocabOrDimParam`` and ``VocabularyMapParam``.
Expand Down
51 changes: 17 additions & 34 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,46 +1,29 @@
*********************
Contributing to Nengo
*********************
Contributing to Nengo SPA
=========================

Issues and pull requests are always welcome!
We appreciate help from the community to make Nengo better.
Issues and pull requests are always welcome! We appreciate help from the
community to make Nengo SPA better.

Filing issues
=============
-------------

If you find a bug in Nengo,
or think that a certain feature is missing,
please consider
`filing an issue <https://github.com/nengo/nengo/issues>`_!
Please search the currently open issues first
to see if your bug or feature request already exists.
If so, feel free to add a comment to the issue
If you find a bug in Nengo SPA, or think that a certain feature is missing,
please consider `filing an issue <https://github.com/nengo/nengo_spa/issues>`_.
Please search the currently open issues first to see if your bug or feature
request already exists. If so, feel free to add a comment to the issue
so that we know that multiple people are affected.

Making pull requests
====================
--------------------

If you want to fix a bug or add a feature to Nengo,
we welcome pull requests.
Ensure that you fill out all sections of the pull request template,
deleting the comments as you go.
We check most aspects of code style automatically.
Please refer to our
`code style guide
<http://pythonhosted.org/nengo/dev_introduction.html#code-style>`_
for things that we check manually.
If you want to fix a bug or add a feature to Nengo SPA, we welcome pull
requests. We try to maintain 100% test coverage, so any new features should
also include unit tests to cover that change. If you fix a bug it's also a good
idea to add a unit test, so the bug doesn't get un-fixed in the future!

Contributor agreement
=====================
---------------------

We require that all contributions be covered under
our contributor assignment agreement. Please see
`the agreement
<http://pythonhosted.org/nengo/license.html#contributor-assignment-agreement>`_
We require that all contributions be covered under our contributor assignment
agreement. Please see `the agreement <https://www.nengo.ai/caa.html>`_
for instructions on how to sign.

More details
============

For more details on how to contribute to Nengo, please see our
`developer documentation <http://pythonhosted.org/nengo/dev_guide.html>`_.
Loading