Changeset 9376:bcbbac621dcd in orange


Ignore:
Timestamp:
12/16/11 17:07:41 (2 years ago)
Author:
mitar
Branch:
default
Convert:
1ec7eed89106bd64e768712c7dc359da38541298
Message:

Unifying documentation.

Location:
docs
Files:
8 deleted
4 edited

Legend:

Unmodified
Added
Removed
  • docs/reference/rst/conf.py

    r9372 r9376  
    5757# General information about the project. 
    5858project = u'Orange' 
    59 copyright = u'2011, t' 
     59copyright = u'Bioinformatics Laboratory, FRI UL' 
    6060 
    6161# The version info for the project you're documenting, acts as replacement for 
     
    6666version = '2.5' 
    6767# The full version, including alpha/beta/rc tags. 
    68 release = '2.5 BETA' 
     68release = '2.5 beta' 
    6969 
    7070# The language for content autogenerated by Sphinx. Refer to documentation 
     
    118118 
    119119if html_theme == "orange_theme": 
    120         html_theme_options.update({"orangeheaderfooter": "false"}) 
     120    html_theme_options.update({"orangeheaderfooter": "false"}) 
    121121 
    122122# Add any paths that contain custom themes here, relative to this directory. 
     
    125125# The name for this set of Sphinx documents.  If None, it defaults to 
    126126# "<project> v<release> documentation". 
    127 #html_title = None 
     127html_title = "Orange Scripting Reference" 
    128128 
    129129# A shorter title for the navigation bar.  Default is the same as html_title. 
     
    180180 
    181181# Output file base name for HTML help builder. 
    182 htmlhelp_basename = 'testdoc' 
     182htmlhelp_basename = 'referencedoc' 
    183183 
    184184 
     
    194194# (source start file, target name, title, author, documentclass [howto/manual]). 
    195195latex_documents = [ 
    196   ('index', 'test.tex', u'test Documentation', 
     196  ('index', 'reference.tex', u'Reference', 
    197197   u't', 'manual'), 
    198198] 
     
    218218 
    219219# Bibliographic Dublin Core info. 
    220 epub_title = u'Orange 2.5 Scripting Reference (DRAFT)' 
     220epub_title = u'Orange Scripting Reference' 
    221221epub_author = u'Biolab' 
    222222epub_publisher = u'Biolab' 
    223 epub_copyright = u'2011, Biolab' 
     223epub_copyright = u'Bioinformatics Laboratory, FRI UL' 
    224224 
    225225# The language of the text. It defaults to the language option 
  • docs/sphinx-ext/themes/orange_theme/page.html

    r9372 r9376  
    22 
    33{% block body %} 
    4       <div class="sphinxsidebar"> 
     4    <div class="sphinxsidebar"> 
    55        <div class="sphinxsidebarwrapper"> 
    6            <p><a class="uplink" href="{{ pathto(master_doc) }}">Orange Documentation</a> 
    7            </p> 
     6           <p><a class="uplink" href="{{ pathto(master_doc) }}">{{ shorttitle }}</a></p> 
    87           {{ toc }} 
    98        </div> 
    10       </div> 
    11   {{ super() }} 
     9    </div> 
     10    {{ super() }} 
    1211{% endblock %}  
  • docs/tutorial/rst/conf.py

    r9372 r9376  
    2323# Add any Sphinx extension module names here, as strings. They can be extensions 
    2424# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    25 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath'] 
     25extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.pngmath'] 
    2626 
    2727# Add any paths that contain templates here, relative to this directory. 
     
    3838 
    3939# General information about the project. 
    40 project = u'Start with Orange' 
     40project = u'Orange' 
    4141copyright = u'Bioinformatics Laboratory, FRI UL' 
    4242 
     
    4646# 
    4747# The short X.Y version. 
    48 version = '2.0b' 
     48version = '2.5' 
    4949# The full version, including alpha/beta/rc tags. 
    50 release = '2.0b' 
     50release = '2.5 beta' 
    5151 
    5252# The language for content autogenerated by Sphinx. Refer to documentation 
     
    9797# further.  For a list of options available for each theme, see the 
    9898# documentation. 
    99 html_theme_options = {"collapsiblesidebar": "true"} 
     99html_theme_options = {"collapsiblesidebar": "false"} 
    100100 
    101101if html_theme == "orange_theme": 
     
    107107# The name for this set of Sphinx documents.  If None, it defaults to 
    108108# "<project> v<release> documentation". 
    109 html_title = project 
     109html_title = "Orange Tutorial" 
    110110 
    111111# A shorter title for the navigation bar.  Default is the same as html_title. 
     
    124124# relative to this directory. They are copied after the builtin static files, 
    125125# so a file named "default.css" will overwrite the builtin "default.css". 
    126 html_static_path = ['_static'] 
     126html_static_path = [] 
    127127 
    128128# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 
     
    162162 
    163163# Output file base name for HTML help builder. 
    164 htmlhelp_basename = 'ofbdoc' 
     164htmlhelp_basename = 'tutorialdoc' 
    165165 
    166166 
     
    176176# (source start file, target name, title, author, documentclass [howto/manual]). 
    177177latex_documents = [ 
    178   ('index', 'ofb.tex', u'ofb Documentation', 
    179    u'Blaz Zupan', 'manual'), 
     178  ('index', 'tutorial.tex', u'Tutorial', 
     179   u'Biolab', 'manual'), 
    180180] 
    181181 
     
    196196# If false, no module index is generated. 
    197197#latex_use_modindex = True 
     198 
     199# -- Options for Epub output --------------------------------------------------- 
     200 
     201# Bibliographic Dublin Core info. 
     202epub_title = u'Orange Tutorial' 
     203epub_author = u'Biolab' 
     204epub_publisher = u'Biolab' 
     205epub_copyright = u'Bioinformatics Laboratory, FRI UL' 
     206 
     207# The language of the text. It defaults to the language option 
     208# or en if the language is not set. 
     209epub_language = 'en' 
     210 
     211# The scheme of the identifier. Typical schemes are ISBN or URL. 
     212#epub_scheme = '' 
     213 
     214# The unique identifier of the text. This can be a ISBN number 
     215# or the project homepage. 
     216#epub_identifier = '' 
     217 
     218# A unique identification for the text. 
     219#epub_uid = '' 
     220 
     221# HTML files that should be inserted before the pages created by sphinx. 
     222# The format is a list of tuples containing the path and title. 
     223#epub_pre_files = [] 
     224 
     225# HTML files that should be inserted after the pages created by sphinx. 
     226# The format is a list of tuples containing the path and title. 
     227#epub_post_files = [] 
     228 
     229# A list of files that should not be packed into the epub file. 
     230epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"] 
     231 
     232# The depth of the table of contents in toc.ncx. 
     233#epub_tocdepth = 3 
     234 
     235# Allow duplicate toc entries. 
     236#epub_tocdup = True 
     237 
     238# Example configuration for intersphinx: refer to the Python standard library. 
     239intersphinx_mapping = {'http://docs.python.org/': None} 
  • docs/widgets/Makefile

    r9372 r9376  
    1919    @echo "  html      to make standalone HTML files" 
    2020    @echo "  dirhtml   to make HTML files named index.html in directories" 
     21    @echo "  epub      to make epub file" 
    2122    @echo "  pickle    to make pickle files" 
    2223    @echo "  json      to make JSON files" 
     
    2930 
    3031clean: 
    31     -rm -rf _build/* 
     32    -rm -rf _* *.html html .doctrees .buildinfo searchindex.js *.epub epub 
     33 
     34epub: 
     35    $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) epub 
     36    mv epub/*.epub . 
     37    @echo 
     38    @echo "Build finished. The epub pages are in " 
    3239 
    3340html: 
    34     $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) . 
     41    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) html 
    3542    @echo 
    3643    @echo "Build finished. The HTML pages are in .. ." 
Note: See TracChangeset for help on using the changeset viewer.