Skip to content

Commit 85f7021

Browse files
ed7coyneed7coyne
committed
Merge pull request FirebaseExtended#125 from ed7coyne/add-arduino-docs
Support ArduinoDocs and ReadTheDocs
2 parents e326b43 + 4736891 commit 85f7021

File tree

5 files changed

+250
-0
lines changed

5 files changed

+250
-0
lines changed

‎README.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
FirebaseArduino is a library to simplify connecting to the Firebase cloud database from
2+
arduino clients.
3+
4+
It is a full abstraction of Firebase's REST API exposed through C++ calls in a wiring
5+
friendly way. All Json parsing is handled by the library and you may deal in pure C/Arduino
6+
types.
7+
8+
----------------------------------

‎extras/docs/Doxyfile

+199
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
DOXYFILE_ENCODING = UTF-8
2+
PROJECT_NAME = firebase-arduino
3+
PROJECT_NUMBER =
4+
PROJECT_BRIEF =
5+
PROJECT_LOGO =
6+
OUTPUT_DIRECTORY = .
7+
CREATE_SUBDIRS = NO
8+
ALLOW_UNICODE_NAMES = NO
9+
OUTPUT_LANGUAGE = English
10+
BRIEF_MEMBER_DESC = YES
11+
REPEAT_BRIEF = YES
12+
ABBREVIATE_BRIEF = "The $name class" "The $name widget" "The $name file" is provides specifies contains represents a an the
13+
ALWAYS_DETAILED_SEC = NO
14+
INLINE_INHERITED_MEMB = NO
15+
FULL_PATH_NAMES = YES
16+
SHORT_NAMES = NO
17+
JAVADOC_AUTOBRIEF = YES
18+
QT_AUTOBRIEF = NO
19+
MULTILINE_CPP_IS_BRIEF = NO
20+
INHERIT_DOCS = YES
21+
SEPARATE_MEMBER_PAGES = NO
22+
TAB_SIZE = 4
23+
OPTIMIZE_OUTPUT_FOR_C = NO
24+
OPTIMIZE_OUTPUT_JAVA = NO
25+
OPTIMIZE_FOR_FORTRAN = NO
26+
OPTIMIZE_OUTPUT_VHDL = NO
27+
MARKDOWN_SUPPORT = YES
28+
AUTOLINK_SUPPORT = YES
29+
BUILTIN_STL_SUPPORT = NO
30+
CPP_CLI_SUPPORT = NO
31+
SIP_SUPPORT = NO
32+
IDL_PROPERTY_SUPPORT = YES
33+
DISTRIBUTE_GROUP_DOC = NO
34+
SUBGROUPING = YES
35+
INLINE_GROUPED_CLASSES = NO
36+
INLINE_SIMPLE_STRUCTS = NO
37+
TYPEDEF_HIDES_STRUCT = NO
38+
LOOKUP_CACHE_SIZE = 0
39+
EXTRACT_ALL = NO
40+
EXTRACT_PRIVATE = NO
41+
EXTRACT_STATIC = NO
42+
EXTRACT_LOCAL_CLASSES = YES
43+
EXTRACT_LOCAL_METHODS = NO
44+
EXTRACT_ANON_NSPACES = NO
45+
HIDE_UNDOC_MEMBERS = NO
46+
HIDE_UNDOC_CLASSES = NO
47+
HIDE_FRIEND_COMPOUNDS = NO
48+
HIDE_IN_BODY_DOCS = NO
49+
INTERNAL_DOCS = NO
50+
CASE_SENSE_NAMES = NO
51+
HIDE_SCOPE_NAMES = NO
52+
HIDE_COMPOUND_REFERENCE= NO
53+
SHOW_INCLUDE_FILES = YES
54+
SHOW_GROUPED_MEMB_INC = NO
55+
FORCE_LOCAL_INCLUDES = NO
56+
INLINE_INFO = YES
57+
SORT_MEMBER_DOCS = YES
58+
SORT_BRIEF_DOCS = NO
59+
SORT_MEMBERS_CTORS_1ST = NO
60+
SORT_GROUP_NAMES = NO
61+
SORT_BY_SCOPE_NAME = NO
62+
STRICT_PROTO_MATCHING = NO
63+
GENERATE_TODOLIST = YES
64+
GENERATE_TESTLIST = YES
65+
GENERATE_BUGLIST = YES
66+
GENERATE_DEPRECATEDLIST= YES
67+
MAX_INITIALIZER_LINES = 30
68+
SHOW_USED_FILES = YES
69+
SHOW_FILES = YES
70+
SHOW_NAMESPACES = YES
71+
QUIET = NO
72+
WARNINGS = YES
73+
WARN_IF_UNDOCUMENTED = YES
74+
WARN_IF_DOC_ERROR = YES
75+
WARN_NO_PARAMDOC = NO
76+
WARN_FORMAT = "$file:$line: $text"
77+
INPUT = ../../src
78+
INPUT_ENCODING = UTF-8
79+
FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.h *.hxx *.hpp *.h++
80+
RECURSIVE = YES
81+
EXCLUDE_SYMLINKS = NO
82+
EXAMPLE_PATTERNS = *
83+
EXAMPLE_RECURSIVE = NO
84+
FILTER_SOURCE_FILES = NO
85+
SOURCE_BROWSER = NO
86+
INLINE_SOURCES = NO
87+
STRIP_CODE_COMMENTS = YES
88+
REFERENCED_BY_RELATION = NO
89+
REFERENCES_RELATION = NO
90+
REFERENCES_LINK_SOURCE = YES
91+
SOURCE_TOOLTIPS = YES
92+
USE_HTAGS = NO
93+
VERBATIM_HEADERS = YES
94+
CLANG_ASSISTED_PARSING = NO
95+
ALPHABETICAL_INDEX = YES
96+
COLS_IN_ALPHA_INDEX = 5
97+
GENERATE_HTML = NO
98+
HTML_OUTPUT = html
99+
HTML_FILE_EXTENSION = .html
100+
HTML_COLORSTYLE_HUE = 220
101+
HTML_COLORSTYLE_SAT = 100
102+
HTML_COLORSTYLE_GAMMA = 80
103+
HTML_TIMESTAMP = YES
104+
HTML_DYNAMIC_SECTIONS = NO
105+
HTML_INDEX_NUM_ENTRIES = 100
106+
GENERATE_DOCSET = NO
107+
DOCSET_FEEDNAME = "Doxygen generated docs"
108+
DOCSET_BUNDLE_ID = org.doxygen.firebase-arduino
109+
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
110+
DOCSET_PUBLISHER_NAME = Publisher
111+
GENERATE_HTMLHELP = NO
112+
GENERATE_CHI = NO
113+
BINARY_TOC = NO
114+
TOC_EXPAND = NO
115+
GENERATE_QHP = NO
116+
QHP_NAMESPACE = org.doxygen.firebase-arduino
117+
QHP_VIRTUAL_FOLDER = doc
118+
GENERATE_ECLIPSEHELP = NO
119+
ECLIPSE_DOC_ID = org.doxygen.firebase-arduino
120+
DISABLE_INDEX = NO
121+
GENERATE_TREEVIEW = NO
122+
ENUM_VALUES_PER_LINE = 4
123+
TREEVIEW_WIDTH = 250
124+
EXT_LINKS_IN_WINDOW = NO
125+
FORMULA_FONTSIZE = 10
126+
FORMULA_TRANSPARENT = YES
127+
USE_MATHJAX = NO
128+
MATHJAX_FORMAT = HTML-CSS
129+
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
130+
SEARCHENGINE = YES
131+
SERVER_BASED_SEARCH = NO
132+
EXTERNAL_SEARCH = NO
133+
SEARCHDATA_FILE = searchdata.xml
134+
GENERATE_LATEX = NO
135+
LATEX_OUTPUT = latex
136+
LATEX_CMD_NAME = latex
137+
MAKEINDEX_CMD_NAME = makeindex
138+
COMPACT_LATEX = NO
139+
PAPER_TYPE = a4
140+
PDF_HYPERLINKS = YES
141+
USE_PDFLATEX = YES
142+
LATEX_BATCHMODE = NO
143+
LATEX_HIDE_INDICES = NO
144+
LATEX_SOURCE_CODE = NO
145+
LATEX_BIB_STYLE = plain
146+
GENERATE_RTF = NO
147+
RTF_OUTPUT = rtf
148+
COMPACT_RTF = NO
149+
RTF_HYPERLINKS = NO
150+
RTF_SOURCE_CODE = NO
151+
GENERATE_MAN = NO
152+
MAN_OUTPUT = man
153+
MAN_EXTENSION = .3
154+
MAN_LINKS = NO
155+
GENERATE_XML = YES
156+
XML_OUTPUT = xml
157+
XML_PROGRAMLISTING = YES
158+
GENERATE_DOCBOOK = NO
159+
DOCBOOK_OUTPUT = docbook
160+
DOCBOOK_PROGRAMLISTING = NO
161+
GENERATE_AUTOGEN_DEF = NO
162+
GENERATE_PERLMOD = NO
163+
PERLMOD_LATEX = NO
164+
PERLMOD_PRETTY = YES
165+
ENABLE_PREPROCESSING = YES
166+
MACRO_EXPANSION = NO
167+
EXPAND_ONLY_PREDEF = NO
168+
SEARCH_INCLUDES = YES
169+
SKIP_FUNCTION_MACROS = YES
170+
ALLEXTERNALS = NO
171+
EXTERNAL_GROUPS = YES
172+
EXTERNAL_PAGES = YES
173+
PERL_PATH = /usr/bin/perl
174+
CLASS_DIAGRAMS = NO
175+
HIDE_UNDOC_RELATIONS = YES
176+
HAVE_DOT = NO
177+
DOT_NUM_THREADS = 0
178+
DOT_FONTNAME = Helvetica
179+
DOT_FONTSIZE = 10
180+
CLASS_GRAPH = YES
181+
COLLABORATION_GRAPH = YES
182+
GROUP_GRAPHS = YES
183+
UML_LOOK = NO
184+
UML_LIMIT_NUM_FIELDS = 10
185+
TEMPLATE_RELATIONS = NO
186+
INCLUDE_GRAPH = YES
187+
INCLUDED_BY_GRAPH = YES
188+
CALL_GRAPH = NO
189+
CALLER_GRAPH = NO
190+
GRAPHICAL_HIERARCHY = YES
191+
DIRECTORY_GRAPH = YES
192+
DOT_IMAGE_FORMAT = png
193+
INTERACTIVE_SVG = NO
194+
DOT_GRAPH_MAX_NODES = 50
195+
MAX_DOT_GRAPH_DEPTH = 0
196+
DOT_TRANSPARENT = NO
197+
DOT_MULTI_TARGETS = NO
198+
GENERATE_LEGEND = YES
199+
DOT_CLEANUP = YES

‎extras/docs/conf.py

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import sys
2+
import os
3+
import shlex
4+
import subprocess
5+
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
6+
if read_the_docs_build:
7+
subprocess.call('doxygen', shell=True)
8+
extensions = ['breathe']
9+
breathe_projects = { 'firebase-arduino': 'xml' }
10+
breathe_default_project = "firebase-arduino"
11+
templates_path = ['_templates']
12+
source_suffix = '.rst'
13+
master_doc = 'index'
14+
project = u'firebase-arduino'
15+
copyright = u'2015, firebase-arduino'
16+
author = u'firebase-arduino'
17+
version = '1.0'
18+
release = '1.0'
19+
language = None
20+
exclude_patterns = ['_build']
21+
pygments_style = 'sphinx'
22+
todo_include_todos = False
23+
html_static_path = ['_static']
24+
htmlhelp_basename = 'firebase-arduinodoc'
25+
latex_elements = {
26+
}
27+
latex_documents = [
28+
(master_doc, 'firebase-arduino.tex', u'firebase-arduino Documentation',
29+
u'firebase-arduino', 'manual'),
30+
]

‎extras/docs/index.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. toctree::
2+
:maxdepth: 2
3+
.. include:: ../../README.rst
4+
:end-before: ----
5+
Class Documentation
6+
===================
7+
.. doxygenclass:: firebase-arduino
8+
:project: firebase-arduino
9+
:members:
10+
----
11+
This documentation was built using ArduinoDocs_.
12+
.. _ArduinoDocs: http://arduinodocs.readthedocs.org

‎extras/docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
breathe

0 commit comments

Comments
 (0)