Commits

Fredrik Håård  committed 9bb8d0c

updated doc config

  • Participants
  • Parent commits 95eb2d2

Comments (0)

Files changed (5)

File docs/Makefile

 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/hgapi.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/hgapi.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/"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/hgapi"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/hgapi"
 	@echo "# devhelp"
 
 epub:

File docs/conf.py

 # -*- coding: utf-8 -*-
 #
-# . documentation build configuration file, created by
-# sphinx-quickstart on Thu Dec 22 11:13:32 2011.
+# hgapi documentation build configuration file, created by
+# sphinx-quickstart on Thu Dec 22 11:19:07 2011.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
 master_doc = 'index'
 
 # General information about the project.
-project = u'.'
-copyright = u'2011, Author'
+project = u'hgapi'
+copyright = u'2011, fredrik@haard.se'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = ''
+version = '1.1.0c1'
 # The full version, including alpha/beta/rc tags.
-release = ''
+release = '1.1.0c1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'doc'
+htmlhelp_basename = 'hgapidoc'
 
 
 # -- Options for LaTeX output --------------------------------------------------
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', '.tex', u'. Documentation',
-   u'Author', 'manual'),
+  ('index', 'hgapi.tex', u'hgapi Documentation',
+   u'fredrik@haard.se', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', '', u'. Documentation',
-     [u'Author'], 1)
+    ('index', 'hgapi', u'hgapi Documentation',
+     [u'fredrik@haard.se'], 1)
 ]
 
 # If true, show URL addresses after external links.
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', '', u'. Documentation',
-   u'Author', '', 'One line description of project.',
+  ('index', 'hgapi', u'hgapi Documentation',
+   u'fredrik@haard.se', 'hgapi', 'One line description of project.',
    'Miscellaneous'),
 ]
 
 # -- Options for Epub output ---------------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = u'.'
-epub_author = u'Author'
-epub_publisher = u'Author'
-epub_copyright = u'2011, Author'
+epub_title = u'hgapi'
+epub_author = u'fredrik@haard.se'
+epub_publisher = u'fredrik@haard.se'
+epub_copyright = u'2011, fredrik@haard.se'
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.

File docs/hgapi.rst

 :mod:`hgapi` Package
 --------------------
 
-.. automodule:: hgapi
+.. automodule:: hgapi.__init__
     :members:
     :undoc-members:
     :show-inheritance:

File docs/index.rst

-.. . documentation master file, created by
-   sphinx-quickstart on Thu Dec 22 11:13:32 2011.
+.. hgapi documentation master file, created by
+   sphinx-quickstart on Thu Dec 22 11:19:07 2011.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to .'s documentation!
-=============================
+Welcome to hgapi's documentation!
+=================================
 
 Contents:
 
    :maxdepth: 4
 
    hgapi
-   setup
 
 
 Indices and tables

File docs/make.bat

 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\hgapi.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\hgapi.ghc
 	goto end
 )