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

Proper sphinx documentation #19

Closed
nemesisdesign opened this Issue Oct 20, 2015 · 2 comments

Comments

Projects
None yet
1 participant
@nemesisdesign
Member

nemesisdesign commented Oct 20, 2015

When the OpenWISP Firmware backend will be added (#18) the project will need a dedicated documentation website in order to properly explain the usage of the two backends.

Special cases that really need to be documented:

  • bridges example
  • suggest to define bridges after bridge_members have been defined
  • wireless interfaces "network" attribute
  • default renderer
  • openwisp backend features (see #18)
  • update README.rst
  • update CONTRIBUTING.rst to link docs
  • mode attribute of file inclusion feature

@nemesisdesign nemesisdesign self-assigned this Oct 20, 2015

@nemesisdesign nemesisdesign added this to the 0.2 milestone Oct 20, 2015

@nemesisdesign nemesisdesign modified the milestones: 0.3, 0.2 Nov 3, 2015

nemesisdesign added a commit that referenced this issue Nov 26, 2015

nemesisdesign added a commit that referenced this issue Nov 26, 2015

nemesisdesign added a commit that referenced this issue Nov 27, 2015

nemesisdesign added a commit that referenced this issue Nov 29, 2015

@nemesisdesign

This comment has been minimized.

Member

nemesisdesign commented Nov 29, 2015

Done!

@nemesisdesign

This comment has been minimized.

Member

nemesisdesign commented Nov 30, 2015

Docs are available at http://netjsonconfig.openwisp.org

nemesisdesign added a commit that referenced this issue Dec 1, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment