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

Fix docs in ReadTheDocs #208

Merged
merged 6 commits into from
Aug 13, 2018
Merged

Fix docs in ReadTheDocs #208

merged 6 commits into from
Aug 13, 2018

Conversation

ljvmiranda921
Copy link
Owner

@ljvmiranda921 ljvmiranda921 commented Aug 11, 2018

Minor fixes in our documentation in ReadTheDocs. We can merge to master and do
a patch release to update.

You can check if everything is working by making a local build:

$ cd pyswarms/docs
$ make html

Then go to _build directory, and open index.html in your browser.

Note: Make sure that the Sphinx package is installed.

Description

  • Some examples have missing code blocks. We should use code-block instead of code
  • Decided to separate Tutorials and Use-cases. Tutorials are for understanding the pyswarms API, Use-cases are applications in different fields, etc.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@ljvmiranda921 ljvmiranda921 added bug Bugs, bug fixes, etc. documentation Documentation improvements or fixes labels Aug 11, 2018
@ljvmiranda921 ljvmiranda921 self-assigned this Aug 11, 2018
@ljvmiranda921 ljvmiranda921 requested a review from whzup August 11, 2018 08:53
@ljvmiranda921
Copy link
Owner Author

Check this one first @whzup and if it's all good we can do 0.3.1 patch release 👍

Copy link
Collaborator

@whzup whzup left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@ljvmiranda921 ljvmiranda921 merged commit da8bfad into master Aug 13, 2018
@ljvmiranda921 ljvmiranda921 deleted the fix-docs-rtd branch August 13, 2018 01:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bugs, bug fixes, etc. documentation Documentation improvements or fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants