Skip to content

Commit cb30b9d

Browse files
mmickommicko
committed
Added documentation to main tree (nw)
1 parent a86a53f commit cb30b9d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+10268
-0
lines changed

‎docs/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*.pyc
2+
build

‎docs/CONTRIBUTING.md

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

‎docs/LICENSE

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
CC0 1.0 Universal
2+
3+
Statement of Purpose
4+
5+
The laws of most jurisdictions throughout the world automatically confer
6+
exclusive Copyright and Related Rights (defined below) upon the creator and
7+
subsequent owner(s) (each and all, an "owner") of an original work of
8+
authorship and/or a database (each, a "Work").
9+
10+
Certain owners wish to permanently relinquish those rights to a Work for the
11+
purpose of contributing to a commons of creative, cultural and scientific
12+
works ("Commons") that the public can reliably and without fear of later
13+
claims of infringement build upon, modify, incorporate in other works, reuse
14+
and redistribute as freely as possible in any form whatsoever and for any
15+
purposes, including without limitation commercial purposes. These owners may
16+
contribute to the Commons to promote the ideal of a free culture and the
17+
further production of creative, cultural and scientific works, or to gain
18+
reputation or greater distribution for their Work in part through the use and
19+
efforts of others.
20+
21+
For these and/or other purposes and motivations, and without any expectation
22+
of additional consideration or compensation, the person associating CC0 with a
23+
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
24+
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
25+
and publicly distribute the Work under its terms, with knowledge of his or her
26+
Copyright and Related Rights in the Work and the meaning and intended legal
27+
effect of CC0 on those rights.
28+
29+
1. Copyright and Related Rights. A Work made available under CC0 may be
30+
protected by copyright and related or neighboring rights ("Copyright and
31+
Related Rights"). Copyright and Related Rights include, but are not limited
32+
to, the following:
33+
34+
i. the right to reproduce, adapt, distribute, perform, display, communicate,
35+
and translate a Work;
36+
37+
ii. moral rights retained by the original author(s) and/or performer(s);
38+
39+
iii. publicity and privacy rights pertaining to a person's image or likeness
40+
depicted in a Work;
41+
42+
iv. rights protecting against unfair competition in regards to a Work,
43+
subject to the limitations in paragraph 4(a), below;
44+
45+
v. rights protecting the extraction, dissemination, use and reuse of data in
46+
a Work;
47+
48+
vi. database rights (such as those arising under Directive 96/9/EC of the
49+
European Parliament and of the Council of 11 March 1996 on the legal
50+
protection of databases, and under any national implementation thereof,
51+
including any amended or successor version of such directive); and
52+
53+
vii. other similar, equivalent or corresponding rights throughout the world
54+
based on applicable law or treaty, and any national implementations thereof.
55+
56+
2. Waiver. To the greatest extent permitted by, but not in contravention of,
57+
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
58+
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
59+
and Related Rights and associated claims and causes of action, whether now
60+
known or unknown (including existing as well as future claims and causes of
61+
action), in the Work (i) in all territories worldwide, (ii) for the maximum
62+
duration provided by applicable law or treaty (including future time
63+
extensions), (iii) in any current or future medium and for any number of
64+
copies, and (iv) for any purpose whatsoever, including without limitation
65+
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
66+
the Waiver for the benefit of each member of the public at large and to the
67+
detriment of Affirmer's heirs and successors, fully intending that such Waiver
68+
shall not be subject to revocation, rescission, cancellation, termination, or
69+
any other legal or equitable action to disrupt the quiet enjoyment of the Work
70+
by the public as contemplated by Affirmer's express Statement of Purpose.
71+
72+
3. Public License Fallback. Should any part of the Waiver for any reason be
73+
judged legally invalid or ineffective under applicable law, then the Waiver
74+
shall be preserved to the maximum extent permitted taking into account
75+
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
76+
is so judged Affirmer hereby grants to each affected person a royalty-free,
77+
non transferable, non sublicensable, non exclusive, irrevocable and
78+
unconditional license to exercise Affirmer's Copyright and Related Rights in
79+
the Work (i) in all territories worldwide, (ii) for the maximum duration
80+
provided by applicable law or treaty (including future time extensions), (iii)
81+
in any current or future medium and for any number of copies, and (iv) for any
82+
purpose whatsoever, including without limitation commercial, advertising or
83+
promotional purposes (the "License"). The License shall be deemed effective as
84+
of the date CC0 was applied by Affirmer to the Work. Should any part of the
85+
License for any reason be judged legally invalid or ineffective under
86+
applicable law, such partial invalidity or ineffectiveness shall not
87+
invalidate the remainder of the License, and in such case Affirmer hereby
88+
affirms that he or she will not (i) exercise any of his or her remaining
89+
Copyright and Related Rights in the Work or (ii) assert any associated claims
90+
and causes of action with respect to the Work, in either case contrary to
91+
Affirmer's express Statement of Purpose.
92+
93+
4. Limitations and Disclaimers.
94+
95+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
96+
surrendered, licensed or otherwise affected by this document.
97+
98+
b. Affirmer offers the Work as-is and makes no representations or warranties
99+
of any kind concerning the Work, express, implied, statutory or otherwise,
100+
including without limitation warranties of title, merchantability, fitness
101+
for a particular purpose, non infringement, or the absence of latent or
102+
other defects, accuracy, or the present or absence of errors, whether or not
103+
discoverable, all to the greatest extent permissible under applicable law.
104+
105+
c. Affirmer disclaims responsibility for clearing rights of other persons
106+
that may apply to the Work or any use thereof, including without limitation
107+
any person's Copyright and Related Rights in the Work. Further, Affirmer
108+
disclaims responsibility for obtaining any necessary consents, permissions
109+
or other rights required for any use of the Work.
110+
111+
d. Affirmer understands and acknowledges that Creative Commons is not a
112+
party to this document and has no duty or obligation with respect to this
113+
CC0 or use of the Work.
114+
115+
For more information, please see
116+
<http://creativecommons.org/publicdomain/zero/1.0/>
117+

‎docs/Makefile

+158
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14+
# the i18n builder cannot share the environment and doctrees with the others
15+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16+
17+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18+
19+
help:
20+
@echo "Please use \`make <target>' where <target> is one of"
21+
@echo " html to make standalone HTML files"
22+
@echo " dirhtml to make HTML files named index.html in directories"
23+
@echo " singlehtml to make a single large HTML file"
24+
@echo " pickle to make pickle files"
25+
@echo " json to make JSON files"
26+
@echo " htmlhelp to make HTML files and a HTML help project"
27+
@echo " qthelp to make HTML files and a qthelp project"
28+
@echo " devhelp to make HTML files and a Devhelp project"
29+
@echo " epub to make an epub"
30+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
32+
@echo " text to make text files"
33+
@echo " man to make manual pages"
34+
@echo " texinfo to make Texinfo files"
35+
@echo " info to make Texinfo files and run them through makeinfo"
36+
@echo " gettext to make PO message catalogs"
37+
@echo " changes to make an overview of all changed/added/deprecated items"
38+
@echo " linkcheck to check all external links for integrity"
39+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
40+
41+
clean:
42+
-rm -rf $(BUILDDIR)/*
43+
44+
site: html epub latexpdf
45+
-mkdir build/html/_files
46+
-cp build/epub/MAMEDocumentation.epub build/html/_files/MAME.epub
47+
-cp build/latex/MAME.pdf build/html/_files/MAME.pdf
48+
49+
html:
50+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
51+
@echo
52+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
53+
54+
dirhtml:
55+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
56+
@echo
57+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
58+
59+
singlehtml:
60+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
61+
@echo
62+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
63+
64+
pickle:
65+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
66+
@echo
67+
@echo "Build finished; now you can process the pickle files."
68+
69+
json:
70+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
71+
@echo
72+
@echo "Build finished; now you can process the JSON files."
73+
74+
htmlhelp:
75+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
76+
@echo
77+
@echo "Build finished; now you can run HTML Help Workshop with the" \
78+
".hhp project file in $(BUILDDIR)/htmlhelp."
79+
80+
qthelp:
81+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
82+
@echo
83+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
84+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
85+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SphinxRTDthemedemo.qhcp"
86+
@echo "To view the help file:"
87+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SphinxRTDthemedemo.qhc"
88+
89+
devhelp:
90+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
91+
@echo
92+
@echo "Build finished."
93+
@echo "To view the help file:"
94+
@echo "# mkdir -p $$HOME/.local/share/devhelp/SphinxRTDthemedemo"
95+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SphinxRTDthemedemo"
96+
@echo "# devhelp"
97+
98+
epub:
99+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
100+
@echo
101+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
102+
103+
latex:
104+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
105+
@echo
106+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
107+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
108+
"(use \`make latexpdf' here to do that automatically)."
109+
110+
latexpdf:
111+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
112+
@echo "Running LaTeX files through pdflatex..."
113+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
114+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
115+
116+
text:
117+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
118+
@echo
119+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
120+
121+
man:
122+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
123+
@echo
124+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
125+
126+
texinfo:
127+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
128+
@echo
129+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
130+
@echo "Run \`make' in that directory to run these through makeinfo" \
131+
"(use \`make info' here to do that automatically)."
132+
133+
info:
134+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
135+
@echo "Running Texinfo files through makeinfo..."
136+
make -C $(BUILDDIR)/texinfo info
137+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
138+
139+
gettext:
140+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
141+
@echo
142+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
143+
144+
changes:
145+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
146+
@echo
147+
@echo "The overview file is in $(BUILDDIR)/changes."
148+
149+
linkcheck:
150+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
151+
@echo
152+
@echo "Link check complete; look for any errors in the above output " \
153+
"or in $(BUILDDIR)/linkcheck/output.txt."
154+
155+
doctest:
156+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
157+
@echo "Testing of doctests in the sources finished, look at the " \
158+
"results in $(BUILDDIR)/doctest/output.txt."

‎docs/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
MAME Documentation
2+
==================
3+
4+
This project provides the source for [docs.mamedev.org](http://docs.mamedev.org/). You can find MAME at the [Home](https://github.com/mamedev/mame) repo.

‎docs/source/__init__.py

Whitespace-only changes.

‎docs/source/_ext/edit_on_github.py

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
"""
2+
Sphinx extension to add ReadTheDocs-style "Edit on GitHub" links to the
3+
sidebar.
4+
5+
Loosely based on https://github.com/astropy/astropy/pull/347
6+
"""
7+
8+
import os
9+
import warnings
10+
11+
12+
__licence__ = 'BSD (3 clause)'
13+
14+
15+
def get_github_url(app, view, path):
16+
return 'https://github.com/{project}/{view}/{branch}/{path}'.format(
17+
project=app.config.edit_on_github_project,
18+
view=view,
19+
branch=app.config.edit_on_github_branch,
20+
path=path)
21+
22+
23+
def html_page_context(app, pagename, templatename, context, doctree):
24+
if templatename != 'page.html':
25+
return
26+
27+
if not app.config.edit_on_github_project:
28+
warnings.warn("edit_on_github_project not specified")
29+
return
30+
31+
path = os.path.relpath(doctree.get('source'), app.builder.srcdir)
32+
show_url = get_github_url(app, 'blob', path)
33+
edit_url = get_github_url(app, 'edit', path)
34+
35+
context['show_on_github_url'] = show_url
36+
context['edit_on_github_url'] = edit_url
37+
38+
39+
def setup(app):
40+
app.add_config_value('edit_on_github_project', '', True)
41+
app.add_config_value('edit_on_github_branch', 'master', True)
42+
app.connect('html-page-context', html_page_context)

0 commit comments

Comments
 (0)