diff --git a/.hgignore b/.hgignore index 1453aed71..a49037122 100644 --- a/.hgignore +++ b/.hgignore @@ -2,3 +2,4 @@ ^beets\.egg-info/ ^build/ ^MANIFEST$ +^docs/_build/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..3484f95c4 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,130 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/beets.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/beets.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/beets" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/beets" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + make -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..fe6487003 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,40 @@ +AUTHOR = u'Adrian Sampson' + +# -- General configuration ----------------------------------------------------- + +extensions = [] + +#templates_path = ['_templates'] +exclude_patterns = ['_build'] +source_suffix = '.rst' +master_doc = 'index' + +project = u'beets' +copyright = u'2011, %s' % AUTHOR + +version = '1.0' +release = '1.0b10' + +pygments_style = 'sphinx' + +# -- Options for HTML output --------------------------------------------------- + +html_theme = 'default' +#html_static_path = ['_static'] +htmlhelp_basename = 'beetsdoc' + +# -- Options for LaTeX output -------------------------------------------------- + +latex_documents = [ + ('index', 'beets.tex', u'beets Documentation', + AUTHOR, 'manual'), +] + +# -- Options for manual page output -------------------------------------------- + +man_pages = [ + ('reference/cli', 'beet', u'beets command-line interface', + [AUTHOR], 1), + ('reference/config', 'beetsconfig', u'beets configuration file', + [AUTHOR], 5), +] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..8f71bc927 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,13 @@ +beets: the music geek's media organizer +======================================= + +Intro text. + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + starting/index + reference/index diff --git a/docs/reference/cli.rst b/docs/reference/cli.rst new file mode 100644 index 000000000..6770e4429 --- /dev/null +++ b/docs/reference/cli.rst @@ -0,0 +1,4 @@ +Command-Line Interface +====================== + +cli diff --git a/docs/reference/config.rst b/docs/reference/config.rst new file mode 100644 index 000000000..fb0e365c9 --- /dev/null +++ b/docs/reference/config.rst @@ -0,0 +1,4 @@ +.beetsconfig +============ + +Config diff --git a/docs/reference/index.rst b/docs/reference/index.rst new file mode 100644 index 000000000..e6e4b2c0a --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,8 @@ +Reference +========= + +.. toctree:: + :maxdepth: 2 + + cli + config diff --git a/docs/starting/index.rst b/docs/starting/index.rst new file mode 100644 index 000000000..dd7a42151 --- /dev/null +++ b/docs/starting/index.rst @@ -0,0 +1,10 @@ +Introduction +============ + +Tutorial stuff + +.. toctree:: + :maxdepth: 2 + + main + tagger diff --git a/docs/starting/main.rst b/docs/starting/main.rst new file mode 100644 index 000000000..d1e9e77eb --- /dev/null +++ b/docs/starting/main.rst @@ -0,0 +1,4 @@ +Getting Started +=============== + +The first tutorial stuff diff --git a/docs/starting/tagger.rst b/docs/starting/tagger.rst new file mode 100644 index 000000000..7f393bf46 --- /dev/null +++ b/docs/starting/tagger.rst @@ -0,0 +1,4 @@ +Using the Auto-Tagger +===================== + +Tagger tut