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

Proper sphinx documentation #19

Closed
8 tasks done
nemesifier opened this issue Oct 20, 2015 · 2 comments
Closed
8 tasks done

Proper sphinx documentation #19

nemesifier opened this issue Oct 20, 2015 · 2 comments
Assignees
@nemesifier
Labels
enhancement
Milestone
0.3

Comments

@nemesifier
Copy link
Member

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 Add backend for OpenWISP Firmware 1.3.x #18)
  • update README.rst
  • update CONTRIBUTING.rst to link docs
  • mode attribute of file inclusion feature
@nemesifier nemesifier self-assigned this Oct 20, 2015
@nemesifier nemesifier added this to the 0.2 milestone Oct 20, 2015
@nemesifier nemesifier modified the milestones: 0.3, 0.2 Nov 3, 2015
nemesifier added a commit that referenced this issue Nov 26, 2015
@nemesifier
[docs] Added documentation structure #19
3bc0db7
nemesifier added a commit that referenced this issue Nov 26, 2015
@nemesifier
[docs] Corrected link to openwisp.org in index #19
1504fb6
nemesifier added a commit that referenced this issue Nov 27, 2015
@nemesifier
[docs] Added details of OpenWrt backend #19
e8cd9ec
nemesifier added a commit that referenced this issue Nov 27, 2015
@nemesifier
[docs] Added details of OpenWisp backend #19
17a00fc
nemesifier added a commit that referenced this issue Nov 27, 2015
@nemesifier
[docs] Updated CONTRIBUTING.rst #19
81b4bf6
nemesifier added a commit that referenced this issue Nov 27, 2015
@nemesifier
[docs] Updated README #19
a1641e7
nemesifier added a commit that referenced this issue Nov 29, 2015
@nemesifier
[docs] Documented "mode" attribute of file inclusion feature #19
244b678
nemesifier added a commit that referenced this issue Nov 29, 2015
@nemesifier
[docs] Minor refinements to OpenWrt backend page #19
2a38c76
nemesifier added a commit that referenced this issue Nov 29, 2015
@nemesifier
[docs] Corrected another openwisp.org link #19
50c6baf
@nemesifier
Copy link
Member Author

Done!

@nemesifier
Copy link
Member Author

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

nemesifier added a commit that referenced this issue Dec 1, 2015
@nemesifier
[docs] Added "Goals and Motivations" page #19
a0720f4
nemesifier added a commit that referenced this issue Dec 1, 2015
@nemesifier
[docs] Added link to change log #19
9f107b4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nemesifier nemesifier

Labels
enhancement
Projects
None yet
Milestone
0.3
Development

No branches or pull requests
1 participant
@nemesifier