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.

Sign up for GitHub

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

Jump to bottom

sphinx templates, removed mpi4py from extras #355

Merged
merged 10 commits into from
Oct 30, 2020
Merged

sphinx templates, removed mpi4py from extras #355

merged 10 commits into from
Oct 30, 2020

Conversation

dizcza
Copy link
Member

@dizcza dizcza commented Oct 5, 2020 •
edited
Loading

When understood, a class template is a handy tool in Sphinx.

The __call__ method will be documented only if it's overridden. Therefore, we can safely remove hard-coded templates for kernels and ASSET, and future classes, relying on the auto-build.

Now users need to install mpi4py manually if they want. I added "MPI support" instructions under the installation page of the documentation.

@coveralls
Copy link
Collaborator

coveralls commented Oct 5, 2020 •
edited
Loading

Coverage Status

Coverage increased (+0.01%) to 89.912% when pulling 97b2797 on INM-6:docs/class_template into 11a9e12 on NeuralEnsemble:master.

@dizcza dizcza added the documentation Indicates a need for improvements or additions to documentation label Oct 6, 2020
@dizcza dizcza changed the title [sphinx] doc class template Documentation: added sphinx class template, updated developers guide Oct 7, 2020
mdenker
mdenker reviewed Oct 19, 2020
View reviewed changes
doc/developers_guide.rst Outdated Show resolved Hide resolved
@dizcza @mdenker
Update doc/developers_guide.rst
1b86633 
Co-authored-by: Michael Denker <[email protected]>
mdenker
mdenker reviewed Oct 21, 2020
View reviewed changes
doc/developers_guide.rst Outdated Show resolved Hide resolved
mdenker
mdenker reviewed Oct 21, 2020
View reviewed changes
doc/developers_guide.rst Outdated Show resolved Hide resolved
mdenker
mdenker reviewed Oct 21, 2020
View reviewed changes
doc/developers_guide.rst Outdated Show resolved Hide resolved
dizcza and others added 3 commits October 21, 2020 10:31
mdenker
mdenker approved these changes Oct 21, 2020
View reviewed changes
Copy link
Member

@mdenker mdenker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked that the doc changes look fine on readthedocs, so I think that's good to go.

@dizcza dizcza changed the title Documentation: added sphinx class template, updated developers guide sphinx templates, removed mpi4py from extras Oct 30, 2020
@dizcza dizcza added the enhancement Editing an existing module, improving something label Oct 30, 2020
@dizcza dizcza merged commit d6efd2c into NeuralEnsemble:master Oct 30, 2020
@dizcza dizcza deleted the docs/class_template branch October 30, 2020 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mdenker mdenker mdenker approved these changes

Assignees
No one assigned
Labels
documentation Indicates a need for improvements or additions to documentation enhancement Editing an existing module, improving something
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dizcza @coveralls @mdenker