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

Update documentation in Development Branch #121

Closed
3 tasks done
ljvmiranda921 opened this issue Jun 7, 2018 · 1 comment
Closed
3 tasks done

Update documentation in Development Branch #121

ljvmiranda921 opened this issue Jun 7, 2018 · 1 comment
Labels
documentation Documentation improvements or fixes help wanted Help is much appreciated

Comments

@ljvmiranda921
Copy link
Owner

ljvmiranda921 commented Jun 7, 2018 •
edited
Loading

Description

A lot of things have happened when we added the backend module in PR #115 . The API is still the same, but we changed the backend. It would be nice if we can add some documentation in ReadTheDocs for this backend.

In addition, it would also be nice to add new notebook examples on how to use this backend to develop your own swarm algorithms without using the pre-made GlobalBestPSO, etc. implementations.

If you're up to the task, just ping me here! We'll be working together.

Things to do:

  • Add backend module (.rst files) in the ReadTheDocs documentation
  • Maybe add a separate RTD docs for master and development branch?
  • Jupyter notebook example on backend module (and clean-up/updates of existing notebooks if necessary).
@ljvmiranda921 ljvmiranda921 added help wanted Help is much appreciated documentation Documentation improvements or fixes labels Jun 7, 2018
@ljvmiranda921
Copy link
Owner Author

So it's actually easy to build documentation for different branches, next, change the
README in development so that the documentation badge to the dev branch.

Perhaps the same goes for master?

ljvmiranda921 pushed a commit that referenced this issue Jun 10, 2018
Add documentation for backend (#121)
3a949d7 
This commit adds a documentation for the backend module.
I also updated some docstrings for clearer explanations

Signed-off-by: Lester James V. Miranda <[email protected]>
ljvmiranda921 pushed a commit that referenced this issue Jun 10, 2018
Update docs on developer's guide (#121)
55a7c55 
Add some explanation about the PySwarms API and on how to use
the backend module.

Signed-off-by: Lester James V. Miranda <[email protected]>
ljvmiranda921 pushed a commit that referenced this issue Jun 10, 2018
Update Jupyter Notebook examples (#121)
e035428 
This commit should update all Jupyter notebook examples
to the dev version. Hopefully everything is okay after this.
This also adds a new notebook for demonstrating the custom
optimization loop.

Signed-off-by: Lester James V. Miranda <[email protected]>
ljvmiranda921 pushed a commit that referenced this issue Jun 10, 2018
Add use-case example for custom opts in RTD (#121)
6402be4
ljvmiranda921 pushed a commit that referenced this issue Jun 14, 2018
Add documentation for backend (#121)
91d4fa8 
This commit adds a documentation for the backend module.
I also updated some docstrings for clearer explanations

Signed-off-by: Lester James V. Miranda <[email protected]>
ljvmiranda921 pushed a commit that referenced this issue Jun 14, 2018
Update docs on developer's guide (#121)
9faa3de 
Add some explanation about the PySwarms API and on how to use
the backend module.

Signed-off-by: Lester James V. Miranda <[email protected]>
ljvmiranda921 pushed a commit that referenced this issue Jun 14, 2018
Update Jupyter Notebook examples (#121)
f8f2d66 
This commit should update all Jupyter notebook examples
to the dev version. Hopefully everything is okay after this.
This also adds a new notebook for demonstrating the custom
optimization loop.

Signed-off-by: Lester James V. Miranda <[email protected]>
ljvmiranda921 pushed a commit that referenced this issue Jun 14, 2018
Add use-case example for custom opts in RTD (#121)
d6f22c7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Documentation improvements or fixes help wanted Help is much appreciated
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ljvmiranda921