Contents

All contents of this documentation.

conf.py

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# -*- coding: utf-8 -*-

# Default settings
project = 'Test Builds'
extensions = [
    'sphinx_autorun',
]

# Include all your settings here
html_theme = 'sphinx_rtd_theme'




###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################


#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#


import importlib
import sys
import os.path
from six import string_types

from sphinx import version_info

# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    elif isinstance(source_suffix, (list, tuple)):
        # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
        SUFFIX = source_suffix[0]
    elif isinstance(source_suffix, dict):
        # Sphinx >= 1.8 supports a mapping dictionary for mulitple suffixes
        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
    else:
        # default to .rst
        SUFFIX = '.rst'
else:
    SUFFIX = '.rst'

# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')

# Add RTD Theme only if they aren't overriding it already
using_rtd_theme = (
    (
        'html_theme' in globals() and
        html_theme in ['default'] and
        # Allow people to bail with a hack of having an html_style
        'html_style' not in globals()
    ) or 'html_theme' not in globals()
)
if using_rtd_theme:
    theme = importlib.import_module('sphinx_rtd_theme')
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}
    if 'html_theme_path' in globals():
        html_theme_path.append(theme.get_html_theme_path())
    else:
        html_theme_path = [theme.get_html_theme_path()]

if globals().get('websupport2_base_url', False):
    websupport2_base_url = 'https://readthedocs.org/websupport'
    websupport2_static_url = 'https://assets.readthedocs.org/static/'


#Add project information to the template context.
context = {
    'using_theme': using_rtd_theme,
    'html_theme': html_theme,
    'current_version': "pygments-custom-lexer-apex",
    'version_slug': "pygments-custom-lexer-apex",
    'MEDIA_URL': "https://media.readthedocs.org/",
    'STATIC_URL': "https://assets.readthedocs.org/static/",
    'PRODUCTION_DOMAIN': "readthedocs.org",
    'versions': [
    ("latest", "/en/latest/"),
    ("yaml-v2", "/en/yaml-v2/"),
    ("use-py2", "/en/use-py2/"),
    ("use-image-5.0rc1", "/en/use-image-5.0rc1/"),
    ("unicode-filename", "/en/unicode-filename/"),
    ("d--branch", "/en/d--branch/"),
    ("typlog-theme", "/en/typlog-theme/"),
    ("timeout", "/en/timeout/"),
    ("tag-v2", "/en/tag-v2/"),
    ("tag-v1", "/en/tag-v1/"),
    ("submodule-https-scheme", "/en/submodule-https-scheme/"),
    ("submodule-git-scheme", "/en/submodule-git-scheme/"),
    ("sphinx2", "/en/sphinx2/"),
    ("search-with-old-sphinx-and-theme", "/en/search-with-old-sphinx-and-theme/"),
    ("robots-txt", "/en/robots-txt/"),
    ("requirements-not-found", "/en/requirements-not-found/"),
    ("pygments-custom-lexer-apex", "/en/pygments-custom-lexer-apex/"),
    ("none-formats", "/en/none-formats/"),
    ("nbsphinx-3d-plot", "/en/nbsphinx-3d-plot/"),
    ("multiple-source-suffix", "/en/multiple-source-suffix/"),
    ("japanese-pdf", "/en/japanese-pdf/"),
    ("huge-build-output", "/en/huge-build-output/"),
    ("environment-variables", "/en/environment-variables/"),
    ("datetime", "/en/datetime/"),
    ("custom-404-page", "/en/custom-404-page/"),
    ("conda-env-py3.7", "/en/conda-env-py3.7/"),
    ("conda-env", "/en/conda-env/"),
    ("c-dependencies", "/en/c-dependencies/"),
    ("build-internals", "/en/build-internals/"),
    ("branch-with-slashes", "/en/branch-with-slashes/"),
    ("auto-wipe", "/en/auto-wipe/"),
    ("alabaster-theme", "/en/alabaster-theme/"),
    ],
    'downloads': [ 
    ("htmlzip", "//readthedocs.org/projects/test-builds/downloads/htmlzip/pygments-custom-lexer-apex/"),
    ],
    'subprojects': [ 
    ],
    'slug': 'test-builds',
    'name': u'test-builds',
    'rtd_language': u'en',
    'programming_language': u'words',
    'canonical_url': 'https://test-builds.readthedocs.io/en/nbsphinx-3d-plot/',
    'analytics_code': 'None',
    'single_version': False,
    'conf_py_path': '/docs/',
    'api_host': 'https://readthedocs.org',
    'github_user': 'rtfd',
    'github_repo': 'test-builds',
    'github_version': 'pygments-custom-lexer-apex',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'pygments-custom-lexer-apex',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'pygments-custom-lexer-apex',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'ad_free': False,
    'user_analytics_code': '',
    'global_analytics_code': 'UA-17997319-1',
    'commit': '7ba65f1e',
}




if 'html_context' in globals():
    
    html_context.update(context)
    
else:
    html_context = context

# Add custom RTD extension
if 'extensions' in globals():
    # Insert at the beginning because it can interfere
    # with other extensions.
    # See https://github.com/rtfd/readthedocs.org/pull/4054
    extensions.insert(0, "readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]


project_language = 'en'

# User's Sphinx configurations
language_user = globals().get('language', None)
latex_engine_user = globals().get('latex_engine', None)
latex_elements_user = globals().get('latex_elements', None)

chinese = any([
    language_user in ('zh_CN', 'zh_TW'),
    project_language in ('zh_CN', 'zh_TW'),
])

japanase = any([
    language_user == 'ja',
    project_language == 'ja',
])

if chinese:
    latex_engine = latex_engine_user or 'xelatex'

    # Remove this once xindy gets installed in Docker image and XINDYOPS
    # env variable is supported
    # https://github.com/rtfd/readthedocs-docker-images/pull/98
    latex_use_xindy = False

    latex_elements_rtd = {
        'preamble': '\\usepackage[UTF8]{ctex}\n',
    }
    latex_elements = latex_elements_user or latex_elements_rtd
elif japanase:
    latex_engine = latex_engine_user or 'platex'
    latex_use_xindy = False

pygments-custom-lexer-apex

Uses pygments-lexer-apex (GitHub) package to colorize Salesforce Apex language.

Including FundController.apxc should show this file properly colorized by pygments.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
GLOBAL with sharing class FundController {

    public class PagedResult {

        @AuraEnabled
        public Integer pageSize { get;set; }

        @AuraEnabled
        public Integer page { get;set; }

        @AuraEnabled
        public Integer total { get;set; }

        @AuraEnabled
        public List<Fund__c> funds { get;set; }

    }

    public class Filter {

        @AuraEnabled
        public String searchKey { get;set; }

        @AuraEnabled
        public String assetClass { get;set; }

        @AuraEnabled
        public String sector { get;set; }

        @AuraEnabled
        public Decimal minYtdReturn { get;set; }

        @AuraEnabled
        public Decimal maxYtdReturn { get;set; }

        @AuraEnabled
        public Decimal min1YearReturn { get;set; }

        @AuraEnabled
        public Decimal max1YearReturn { get;set; }

        @AuraEnabled
        public Decimal min5YearReturn { get;set; }

        @AuraEnabled
        public Decimal max5YearReturn { get;set; }
    }

    @AuraEnabled
    public static PagedResult getFunds(String filters, Decimal pageSize, Decimal pageNumber) {
        Filter filter = (Filter) JSON.deserializeStrict(filters, FundController.Filter.class);
        Integer pSize = (Integer)pageSize;
        String key = '%' + filter.searchKey + '%';
        Integer offset = ((Integer)pageNumber - 1) * pSize;
        PagedResult r =  new PagedResult();
        DELETe r;
        r.pageSize = pSize;
        r.page = (Integer) pageNumber;
        r.total = [SELECT count() FROM Fund__c
                   WHERE name LIKE :key
                   AND Asset_Class__c like : (filter.assetClass == '' ? '%' : filter.assetClass)
                   AND Sector__r.Name like : (filter.sector == '' ? '%' : filter.sector)
                   AND YTD_Return__c >= :filter.minYtdReturn AND YTD_Return__c <= :filter.maxYtdReturn
                   AND One_Year_Return__c >= :filter.min1YearReturn AND One_Year_Return__c <= :filter.max1YearReturn
                   AND Five_Year_Return__c >= :filter.min5YearReturn AND Five_Year_Return__c <= :filter.max5YearReturn
                  ];
        r.funds = [SELECT id, name, abbreviation__c, asset_class__c, sector__r.Name, rating__c, YTD_Return__c, One_Year_Return__c, Two_Year_Return__c, Five_Year_Return__c FROM Fund__c
                   WHERE name LIKE :key
                   AND Asset_Class__c like : (filter.assetClass == '' ? '%' : filter.assetClass)
                   AND Sector__r.Name like : (filter.sector == '' ? '%' : filter.sector)
                   AND YTD_Return__c >= :filter.minYtdReturn AND YTD_Return__c <= :filter.maxYtdReturn
                   AND One_Year_Return__c >= :filter.min1YearReturn AND One_Year_Return__c <= :filter.max1YearReturn
                   AND Five_Year_Return__c >= :filter.min5YearReturn AND Five_Year_Return__c <= :filter.max5YearReturn
                   LIMIT :pSize OFFSET :offset];
        return r;
    }

    @AuraEnabled
    public static List<String> getAssetClasses() {
        Schema.DescribeFieldResult result = Fund__c.Asset_Class__c.getDescribe();
        List<Schema.PicklistEntry> entries = result.getPicklistValues();
        List<String> values = new list <String>();
        for (Schema.PicklistEntry entry: entries) {
            values.add(entry.getValue());
        }
        return values;
    }

    @AuraEnabled
    public static Sector__c[] getSectors() {
        return [SELECT Id, Name FROM Sector__c ORDER BY Name];
    }

}

requirements.txt file to install the lexer:

1
2
3
sphinx-autorun

git+https://github.com/shawalli/pygments-lexer-apex.git#egg=pygments-lexer-apex

Sphinx configuration file to build this docs (see full file),

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# -*- coding: utf-8 -*-

# Default settings
project = 'Test Builds'
extensions = [
    'sphinx_autorun',
]

# Include all your settings here
html_theme = 'sphinx_rtd_theme'






>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow()  # UTC
datetime.datetime(2019, 3, 24, 1, 48, 45, 530812)