Changeset 724af06 in sasview for docs/sphinx-docs


Ignore:
Timestamp:
Sep 21, 2017 3:12:37 PM (7 years ago)
Author:
Paul Kienzle <pkienzle@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
12d3e0e
Parents:
ce81f70 (diff), d76c43a (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge branch 'master' into ticket-887-reorg

Location:
docs/sphinx-docs
Files:
4 added
5 edited

Legend:

Unmodified
Added
Removed

  • docs/sphinx-docs/Makefile

    r1d5f5c2 r3194371  
    1616PAPEROPT_a4     = -D latex_paper_size=a4 
    1717PAPEROPT_letter = -D latex_paper_size=letter 
    18 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 
     18ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source-temp 
    1919# the i18n builder cannot share the environment and doctrees with the others 
    2020I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 
    … …  
    5353        rm -rf source/dev/api 
    5454        sphinx-apidoc -o source/dev/api -d 8 ../../src 
    55          
     55 
    5656html: stubs 
    5757        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 

  • docs/sphinx-docs/build_sphinx.py

    r4abc05d8 r6e546f8  
    1818from distutils.dir_util import copy_tree 
    1919from distutils.util import get_platform 
     20from distutils.spawn import find_executable 
     21 
    2022from shutil import copy 
    2123from os import listdir 
    … …  
    324326        print("!!!!NO MODEL DOCS WILL BE BUILT!!!!") 
    325327 
    326  
    327328def retrieve_bumps_docs(): 
    328329    """ 
    … …  
    360361                     SASVIEW_BUILD]) 
    361362 
     363def build_pdf(): 
     364    """ 
     365    Runs sphinx-build for pdf.  Reads in all .rst files and spits out the final html. 
     366    """ 
     367    print("=== Build PDF Docs from ReST Files ===") 
     368    subprocess.call(["sphinx-build", 
     369                     "-b", "latex", # Builder name. TODO: accept as arg to setup.py. 
     370                     "-d", os.path.join(SPHINX_BUILD, "doctrees"), 
     371                     SPHINX_SOURCE, 
     372                     os.path.join(SPHINX_BUILD, "latex")]) 
     373 
     374    LATEXDIR = os.path.join(SPHINX_BUILD, "latex") 
     375    #TODO: Does it need to be done so many time? 
     376    def pdflatex(): 
     377        subprocess.call(["pdflatex", "SasView.tex"], cwd=LATEXDIR) 
     378    pdflatex() 
     379    pdflatex() 
     380    pdflatex() 
     381    subprocess.call(["makeindex", "-s", "python.ist", "SasView.idx"], cwd=LATEXDIR) 
     382    pdflatex() 
     383    pdflatex() 
     384 
     385    print("=== Copy PDF to HTML Directory ===") 
     386    source = os.path.join(LATEXDIR, "SasView.pdf") 
     387    target = os.path.join(SASVIEW_DOCS, "SasView.pdf") 
     388    shutil.copyfile(source, target) 
     389 
    362390def build(): 
    363391    """ 
    364392    Runs sphinx-build.  Reads in all .rst files and spits out the final html. 
    365393    """ 
    366     print("=== Build HTML Docs from Rest Files ===") 
     394    print("=== Build HTML Docs from ReST Files ===") 
    367395    subprocess.call(["sphinx-build", 
    368396                     "-b", "html", # Builder name. TODO: accept as arg to setup.py. 
    … …  
    375403    copy_tree(html, SASVIEW_DOCS) 
    376404 
     405def fetch_katex(version, destination="_static"): 
     406    from zipfile import ZipFile 
     407    import urllib2 
     408    url = "https://github.com/Khan/KaTeX/releases/download/%s/katex.zip" % version 
     409    cache_path = "katex_%s.zip" % version 
     410    if not os.path.exists(cache_path): 
     411        try: 
     412            fd_in = urllib2.urlopen(url) 
     413            with open(cache_path, "wb") as fd_out: 
     414                fd_out.write(fd_in.read()) 
     415        finally: 
     416            fd_in.close() 
     417    with ZipFile(cache_path) as zip: 
     418        zip.extractall(destination) 
     419 
     420def convert_katex(): 
     421    print("=== Preprocess HTML, converting latex to html ===") 
     422    subprocess.call(["node", "convertKaTex.js", SASVIEW_DOCS]) 
     423 
     424def convert_mathjax(): 
     425    print("=== Preprocess HTML, converting latex to html ===") 
     426    subprocess.call(["node", "convertMathJax.js", SASVIEW_DOCS]) 
     427 
     428def fetch_mathjax(): 
     429    subprocess.call(["npm", "install", "mathjax-node-page"]) 
     430    # TODO: copy fonts from node_modules/mathjax/fonts/HTML-CSS/Tex into static 
     431 
    377432def rebuild(): 
    378433    clean() 
    … …  
    380435    retrieve_user_docs() 
    381436    retrieve_bumps_docs() 
     437    #fetch_katex(version=KATEX_VERSION, destination=KATEX_PARENT) 
     438    #fetch_mathjax() 
    382439    apidoc() 
    383440    build() 
     441    if find_executable('latex'): 
     442        build_pdf() 
     443    #convert_katex() 
     444    #convert_mathjax() 
    384445 
    385446    print("=== Done ===") 

  • docs/sphinx-docs/source/conf.py

    r959eb01 rf80b416e  
    3636              'sphinx.ext.coverage', 
    3737              'sphinx.ext.mathjax', 
     38              #'mathjax',  # replacement mathjax that allows a list of paths 
    3839              'dollarmath', 
    3940              'sphinx.ext.viewcode'] 
     41 
     42mathjax_path = ( 
     43    'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?' 
     44    'config=TeX-MML-AM_CHTML') 
     45 
     46# For katex uncomment the following 
     47""" 
     48#STATIC_PATH = '../../_static/' 
     49STATIC_PATH = '' 
     50mathjax_path = [ 
     51    STATIC_PATH + 'katex/katex.min.js', 
     52    STATIC_PATH + 'katex/contrib/auto-render.min.js', 
     53    STATIC_PATH + 'rendermath.js' 
     54] 
     55mathjax_css = STATIC_PATH + 'katex/katex.min.css' 
     56""" 
     57 
    4058 
    4159# Add any paths that contain templates here, relative to this directory. 
    … …  
    6280version = '4.1' 
    6381# The full version, including alpha/beta/rc tags. 
    64 release = '4.1.0' 
     82release = '4.1.2' 
    6583 
    6684# The language for content autogenerated by Sphinx. Refer to documentation 
    … …  
    201219# -- Options for LaTeX output -------------------------------------------------- 
    202220 
     221# TODO: seems like angstroms is defined twice. 
    203222LATEX_PREAMBLE=r""" 
     223\usepackage[utf8]{inputenc}      % Allow unicode symbols in text 
     224\newcommand{\lt}{<}              % HTML needs \lt rather than < 
     225\newcommand{\gt}{>}              % HTML needs \gt rather than > 
    204226\renewcommand{\AA}{\text{\r{A}}} % Allow \AA in math mode 
    205 \usepackage[utf8]{inputenc}      % Allow unicode symbols in text 
     227\DeclareUnicodeCharacter {212B} {\AA}                  % Angstrom 
    206228\DeclareUnicodeCharacter {00B7} {\ensuremath{\cdot}}   % cdot 
    207229\DeclareUnicodeCharacter {00B0} {\ensuremath{^\circ}}  % degrees 
    208 \DeclareUnicodeCharacter {212B} {\AA}                  % Angstrom 
    209230""" 
    210231latex_elements = { 

  • docs/sphinx-docs/source/rst_prolog

    ra45185c r1659f54  
    11.. Set up some substitutions to make life easier... 
    2 .. Remove |biggamma|, etc. when they are no longer needed. 
    32 
    4  
    5 .. |alpha| unicode:: U+03B1 
    6 .. |beta| unicode:: U+03B2 
    7 .. |gamma| unicode:: U+03B3 
    8 .. |delta| unicode:: U+03B4 
    9 .. |epsilon| unicode:: U+03B5 
    10 .. |zeta| unicode:: U+03B6 
    11 .. |eta| unicode:: U+03B7 
    12 .. |theta| unicode:: U+03B8 
    13 .. |iota| unicode:: U+03B9 
    14 .. |kappa| unicode:: U+03BA 
    15 .. |lambda| unicode:: U+03BB 
    16 .. |mu| unicode:: U+03BC 
    17 .. |nu| unicode:: U+03BD 
    18 .. |xi| unicode:: U+03BE 
    19 .. |omicron| unicode:: U+03BF 
    20 .. |pi| unicode:: U+03C0 
    21 .. |rho| unicode:: U+03C1 
    22 .. |sigma| unicode:: U+03C3 
    23 .. |tau| unicode:: U+03C4 
    24 .. |upsilon| unicode:: U+03C5 
    25 .. |phi| unicode:: U+03C6 
    26 .. |chi| unicode:: U+03C7 
    27 .. |psi| unicode:: U+03C8 
    28 .. |omega| unicode:: U+03C9 
    29  
    30  
    31 .. |biggamma| unicode:: U+0393 
    32 .. |bigdelta| unicode:: U+0394 
    33 .. |bigzeta| unicode:: U+039E 
    34 .. |bigpsi| unicode:: U+03A8 
    35 .. |bigphi| unicode:: U+03A6 
    36 .. |bigsigma| unicode:: U+03A3 
    37 .. |Gamma| unicode:: U+0393 
    38 .. |Delta| unicode:: U+0394 
    39 .. |Zeta| unicode:: U+039E 
    40 .. |Psi| unicode:: U+03A8 
    41  
    42  
    43 .. |drho| replace:: |Delta|\ |rho| 
    443.. |Ang| unicode:: U+212B 
    454.. |Ang^-1| replace:: |Ang|\ :sup:`-1` 
    … …  
    5716.. |cm^-3| replace:: cm\ :sup:`-3` 
    5817.. |sr^-1| replace:: sr\ :sup:`-1` 
    59 .. |P0| replace:: P\ :sub:`0`\ 
    60 .. |A2| replace:: A\ :sub:`2`\ 
    61  
    62  
    63 .. |equiv| unicode:: U+2261 
    64 .. |noteql| unicode:: U+2260 
    65 .. |TM| unicode:: U+2122 
    66  
    6718 
    6819.. |cdot| unicode:: U+00B7 

  • docs/sphinx-docs/source/user/tutorial.rst

    r461a917 r2f6d340  
    88.. note:: In Windows use [Alt]-[Cursor left] to return to the previous page 
    99 
    10 :download:`Getting Started with Sasview <../../../../sasview/media/getting_started_with_sasview.pdf>` 
     10:download:`Getting Started with Sasview <../../../../src/sas/sasview/media/getting_started_with_sasview.pdf>` 
    1111 
    12 :download:`Old Tutorial <../../../../sasview/media/Tutorial.pdf>` 
     12:download:`Old Tutorial <../../../../src/sas/sasview/media/Tutorial.pdf>` 
Note: See TracChangeset for help on using the changeset viewer.