Changeset 5cb0c87 in sasview for docs/sphinx-docs


Ignore:
Timestamp:
Sep 5, 2017 2:53:09 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:
96f00a0
Parents:
78d0a9b (diff), f9ba422 (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-639-katex

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

Legend:

Unmodified
Added
Removed

  • docs/sphinx-docs/build_sphinx.py

    rf4771596 r5cb0c87  
    3838#/sasview-local-trunk/docs/sphinx-docs/build_sphinx.py 
    3939SASMODELS_SOURCE_PROLOG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc") 
    40 SASMODELS_SOURCE_GPU = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "gpu") 
    41 SASMODELS_SOURCE_SESANS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "sesans") 
    42 SASMODELS_SOURCE_SESANSIMG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "sesans", "sesans_img") 
    43 SASMODELS_SOURCE_MAGNETISM = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "magnetism") 
    44 SASMODELS_SOURCE_MAGIMG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "magnetism", "mag_img") 
    45 SASMODELS_SOURCE_REF_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "models") 
     40SASMODELS_SOURCE_GPU = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "guide", "gpu") 
     41SASMODELS_SOURCE_SESANS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "guide", "sesans") 
     42SASMODELS_SOURCE_SESANSIMG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "guide", "sesans", "sesans_img") 
     43SASMODELS_SOURCE_MAGNETISM = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "guide", "magnetism") 
     44SASMODELS_SOURCE_MAGIMG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "guide", "magnetism", "mag_img") 
     45SASMODELS_SOURCE_REF_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "guide", "models") 
    4646SASMODELS_SOURCE_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "model") 
    4747SASMODELS_SOURCE_IMG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "model", "img") 

  • 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/source/conf.py

    r959eb01 rf4771596  
    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. 
    … …  
    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\usepackage{underscore}          % Allow underscore outside math mode 
     225\usepackage[T1]{fontenc}         % Use underscore character from font 
     226\newcommand{\lt}{<}              % HTML needs \lt rather than < 
     227\newcommand{\gt}{>}              % HTML needs \gt rather than > 
    204228\renewcommand{\AA}{\text{\r{A}}} % Allow \AA in math mode 
    205 \usepackage[utf8]{inputenc}      % Allow unicode symbols in text 
     229\DeclareUnicodeCharacter {212B} {\AA}                  % Angstrom 
    206230\DeclareUnicodeCharacter {00B7} {\ensuremath{\cdot}}   % cdot 
    207231\DeclareUnicodeCharacter {00B0} {\ensuremath{^\circ}}  % degrees 
    208 \DeclareUnicodeCharacter {212B} {\AA}                  % Angstrom 
    209232""" 
    210233latex_elements = { 

  • docs/sphinx-docs/source/rst_prolog

    ra45185c r62af61fd  
    22.. Remove |biggamma|, etc. when they are no longer needed. 
    33 
     4    .. |alpha| unicode:: U+03B1 
     5    .. |beta| unicode:: U+03B2 
     6    .. |gamma| unicode:: U+03B3 
     7    .. |delta| unicode:: U+03B4 
     8    .. |epsilon| unicode:: U+03B5 
     9    .. |zeta| unicode:: U+03B6 
     10    .. |eta| unicode:: U+03B7 
     11    .. |theta| unicode:: U+03B8 
     12    .. |iota| unicode:: U+03B9 
     13    .. |kappa| unicode:: U+03BA 
     14    .. |lambda| unicode:: U+03BB 
     15    .. |mu| unicode:: U+03BC 
     16    .. |nu| unicode:: U+03BD 
     17    .. |xi| unicode:: U+03BE 
     18    .. |omicron| unicode:: U+03BF 
     19    .. |pi| unicode:: U+03C0 
     20    .. |rho| unicode:: U+03C1 
     21    .. |sigma| unicode:: U+03C3 
     22    .. |tau| unicode:: U+03C4 
     23    .. |upsilon| unicode:: U+03C5 
     24    .. |phi| unicode:: U+03C6 
     25    .. |chi| unicode:: U+03C7 
     26    .. |psi| unicode:: U+03C8 
     27    .. |omega| unicode:: U+03C9 
    428 
    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    .. |biggamma| unicode:: U+0393 
     30    .. |bigdelta| unicode:: U+0394 
     31    .. |bigzeta| unicode:: U+039E 
     32    .. |bigpsi| unicode:: U+03A8 
     33    .. |bigphi| unicode:: U+03A6 
     34    .. |bigsigma| unicode:: U+03A3 
     35    .. |Gamma| unicode:: U+0393 
     36    .. |Delta| unicode:: U+0394 
     37    .. |Zeta| unicode:: U+039E 
     38    .. |Psi| unicode:: U+03A8 
     39 
     40    .. |drho| replace:: |Delta|\ |rho| 
     41 
     42    .. |equiv| unicode:: U+2261 
     43    .. |noteql| unicode:: U+2260 
     44    .. |TM| unicode:: U+2122 
    2945 
    3046 
    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 
    4147 
    42  
    43 .. |drho| replace:: |Delta|\ |rho| 
    4448.. |Ang| unicode:: U+212B 
    4549.. |Ang^-1| replace:: |Ang|\ :sup:`-1` 
    … …  
    6064.. |A2| replace:: A\ :sub:`2`\ 
    6165 
    62  
    63 .. |equiv| unicode:: U+2261 
    64 .. |noteql| unicode:: U+2260 
    65 .. |TM| unicode:: U+2122 
    66  
    67  
    6866.. |cdot| unicode:: U+00B7 
    6967.. |deg| unicode:: U+00B0 
Note: See TracChangeset for help on using the changeset viewer.