Changeset 8127604 in rtems-docs


Ignore:
Timestamp:
Mar 20, 2017, 12:42:56 AM (3 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11
Children:
e9b193a
Parents:
c2c29d8
Message:

Use a single top level version number.

Fix the path in the catalogue links to allow prefix testing on a local
disk.

Close #2940.

Files:
18 edited

Legend:

Unmodified
Added
Removed
  • bsp-howto/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '4.11.0'
    7 release = '4.11.0'
    8 
    96project = "RTEMS BSP and Device Driver Development Guide"
    107
    11 latex_documents = [
    12         ('index', 'bsp-howto.tex', u'RTEMS BSP and Device Driver Development Guide', u'RTEMS Documentation Project', 'manual'),
    13 ]
     8latex_documents = [('index',
     9                    'bsp-howto.tex',
     10                    u'RTEMS BSP and Device Driver Development Guide',
     11                    u'RTEMS Documentation Project', 'manual')]
  • c-user/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '4.11.0'
    7 release = '4.11.0'
    8 
    96project = "RTEMS C User Manual"
    107
    11 latex_documents = [
    12         ('index', 'c-user.tex', u'RTEMS C User Documentation', u'RTEMS Documentation Project', 'manual'),
    13 ]
     8latex_documents = [('index',
     9                    'c-user.tex',
     10                    u'RTEMS C User Documentation',
     11                    u'RTEMS Documentation Project',
     12                    'manual')]
  • common/conf.py

    rc2c29d8 r8127604  
    77def build_date():
    88    now = datetime.date.today()
    9     m = now.strftime('%b')
     9    m = now.strftime('%B')
    1010    y = now.strftime('%Y')
    1111    if now.day % 10 == 1:
     
    5252#
    5353# The short X.Y version.
    54 version = '@VERSION@'
     54#version = '@VERSION@'
    5555
    5656# The full version, including alpha/beta/rc tags.
    57 release = '@RELEASE@'
     57#release = '@RELEASE@'
    5858
    5959# The language for content autogenerated by Sphinx. Refer to documentation
  • common/html-coverpage/static/rtems/js/catalogue.js

    rc2c29d8 r8127604  
    5757            table += empty;
    5858        if (pdf)
    59             table += '<td><a href="' + '/' + pdf + '">' +
     59            table += '<td><a href="' + pdf + '">' +
    6060            '<img src="' + pdfIcon + '" width="20" height="20"></a></td>\n';
    6161        else
    6262            table += empty;
    6363        if (singlehtml)
    64             table += '<td><a href="' + '/' + singlehtml + '">' +
     64            table += '<td><a href="' + singlehtml + '">' +
    6565            '<img src="' + htmlIcon + '" width="20" height="20"></a></td>\n';
    6666        else
  • common/waf.py

    rc2c29d8 r8127604  
    55
    66sphinx_min_version = (1, 3)
     7
     8def build_date():
     9    import datetime
     10    now = datetime.date.today()
     11    m = now.strftime('%B')
     12    y = now.strftime('%Y')
     13    if now.day % 10 == 1:
     14        s = 'st'
     15    elif now.day % 10 == 2:
     16        s = 'nd'
     17    elif now.day == 3:
     18        s = 'rd'
     19    else:
     20        s = 'th'
     21    d = '%2d%s' % (now.day, s)
     22    return '%s %s %s' % (d, m, y)
    723
    824def cmd_spell(ctx):
     
    88104    doctrees = os.path.join(os.path.dirname(output_dir), 'doctrees', buildtype)
    89105    return build_dir, output_node, output_dir, doctrees
     106
     107def version_cmdline(ctx):
     108    return "-Drelease='%s' -Dversion='%s'" % (ctx.env.VERSION, ctx.env.VERSION)
    90109
    91110def pdf_resources(ctx, buildtype):
     
    136155
    137156def cmd_configure(ctx):
     157    ctx.msg('Checking version', ctx.env.VERSION)
     158
    138159    ctx.find_program("sphinx-build", var="BIN_SPHINX_BUILD", mandatory = True)
    139160    ctx.find_program("aspell", var = "BIN_ASPELL", mandatory = False)
     
    181202    build_dir, output_node, output_dir, doctrees = build_dir_setup(ctx, buildtype)
    182203    pdf_resources(ctx, buildtype)
    183     rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s -d %s %s %s" % \
    184            (sphinx_verbose(ctx), buildtype, conf_dir,
     204    rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \
     205           (sphinx_verbose(ctx), buildtype, conf_dir, version_cmdline(ctx),
    185206            doctrees, source_dir, output_dir)
    186207    ctx(
     
    233254    build_dir, output_node, output_dir, doctrees = build_dir_setup(ctx, buildtype)
    234255    html_resources(ctx, buildtype)
    235     rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s -d %s %s %s" % \
    236            (sphinx_verbose(ctx), buildtype, conf_dir,
     256    rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \
     257           (sphinx_verbose(ctx), buildtype, conf_dir, version_cmdline(ctx),
    237258            doctrees, source_dir, output_dir)
    238259    ctx(
     
    255276    build_dir, output_node, output_dir, doctrees = build_dir_setup(ctx, buildtype)
    256277    html_resources(ctx, buildtype)
    257     rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s -d %s %s %s" % \
    258            (sphinx_verbose(ctx), buildtype, conf_dir,
     278    rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \
     279           (sphinx_verbose(ctx), buildtype, conf_dir, version_cmdline(ctx),
    259280            doctrees, source_dir, output_dir)
    260281    ctx(
     
    314335    cmd_configure(ctx)
    315336
    316 def xml_catalogue(ctx, building, title):
     337def xml_catalogue(ctx, building):
    317338    #
    318339    # The following is a hack to find the top_dir because the task does
     
    339360        catalogue[doc] = {
    340361            'title': bconf.project,
    341             'version':  bconf.version,
    342             'release': bconf.release,
     362            'version': str(ctx.env.VERSION),
     363            'release': str(ctx.env.VERSION),
    343364            'pdf': bconf.latex_documents[0][1].replace('.tex', '.pdf'),
    344365            'html': '%s/index.html' % (doc),
     
    351372
    352373    root = cat.createElement('rtems-docs')
    353     root.setAttribute('date', 'today')
     374    root.setAttribute('date', build_date())
    354375    cat.appendChild(root)
    355376
    356377    heading = cat.createElement('catalogue')
    357     text = cat.createTextNode(title)
     378    text = cat.createTextNode(str(ctx.env.VERSION))
    358379    heading.appendChild(text)
    359380    root.appendChild(heading)
  • cpu-supplement/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '1.0'
    7 release = '4.11.0'
    8 
    96project = "RTEMS CPU Supplement Documentation"
    107
    11 latex_documents = [
    12         ('index', 'cpu-supplement.tex', u'RTEMS CPU Supplement Documentation', u'RTEMS Documentation Project', 'manual'),
    13 ]
     8latex_documents = [('index',
     9                    'cpu-supplement.tex',
     10                    u'RTEMS CPU Supplement Documentation',
     11                    u'RTEMS Documentation Project',
     12                    'manual')]
  • develenv/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '4.11.0'
    7 release = '4.11.0'
    8 
    9 latex_documents = [
    10         ('index', 'develenv.tex', u'RTEMS Development Environment Documentation', u'RTEMS Documentation Project', 'manual'),
    11 ]
     6latex_documents = [('index',
     7                    'develenv.tex',
     8                    u'RTEMS Development Environment Documentation',
     9                    u'RTEMS Documentation Project',
     10                    'manual')]
  • eclipse/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '4.11.0'
    7 release = '4.11.0'
    8 
    96project = "RTEMS Eclipse Manual"
    107
    11 latex_documents = [
    12         ('index', 'eclipse.tex', u'RTEMS Eclipse Manual', u'RTEMS Documentation Project', 'manual'),
    13 ]
     8latex_documents = [('index',
     9                    'eclipse.tex',
     10                    u'RTEMS Eclipse Manual',
     11                    u'RTEMS Documentation Project',
     12                    'manual')]
  • filesystem/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '4.11.0'
    7 release = '4.11.0'
    8 
    96project = "RTEMS Filesystem Design Guide"
    107
    11 latex_documents = [
    12         ('index', 'filesystem.tex', u'RTEMS Filesystem Design Guide', u'RTEMS Filesystem Design Guide', 'manual'),
    13 ]
     8latex_documents = [('index',
     9                    'filesystem.tex',
     10                    u'RTEMS Filesystem Design Guide',
     11                    u'RTEMS Filesystem Design Guide',
     12                    'manual')]
  • networking/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '4.11.0'
    7 release = '4.11.0'
    8 
    96project = "RTEMS Networking User Manual"
    107
    11 latex_documents = [
    12         ('index', 'networking.tex', u'RTEMS Networking User Documentation', u'RTEMS Documentation Project', 'manual'),
    13 ]
     8latex_documents = [('index',
     9                    'networking.tex',
     10                    u'RTEMS Networking User Documentation',
     11                    u'RTEMS Documentation Project',
     12                    'manual')]
  • porting/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '1.0'
    7 release = '5.0'
    8 
    9 latex_documents = [
    10         ('index', 'porting.tex', u'RTEMS Porting Documentation', u'RTEMS Documentation Project', 'manual'),
    11 ]
    12 
     6latex_documents = [('index',
     7                    'porting.tex',
     8                    u'RTEMS Porting Documentation',
     9                    u'RTEMS Documentation Project',
     10                    'manual')]
  • posix-users/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '4.11.0'
    7 release = '4.11.0'
    8 
    96project = "RTEMS POSIX User Manual"
    107
    11 latex_documents = [
    12         ('index', 'posix-users.tex', u'RTEMS POSIX API User\'s Guide', u'RTEMS Documentation Project', 'manual'),
    13 ]
     8latex_documents = [('index',
     9                    'posix-users.tex',
     10                    u'RTEMS POSIX API User\'s Guide',
     11                    u'RTEMS Documentation Project',
     12                    'manual')]
  • posix1003-1/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '1.0'
    7 release = '5.0'
    8 
    9 latex_documents = [
    10         ('index', 'posix1003-1.tex', u'RTEMS POSIX 1003_1 Documentation', u'RTEMS Documentation Project', 'manual'),
    11 ]
     6latex_documents = [('index',
     7                    'posix1003-1.tex',
     8                    u'RTEMS POSIX 1003_1 Documentation',
     9                    u'RTEMS Documentation Project',
     10                    'manual')]
  • rsb/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '4.11.0'
    7 release = '4.11.0'
    8 
    96project = "RTEMS Source Builder Manual"
    107
    11 latex_documents = [
    12         ('index', 'rsb.tex', u'RTEMS Source Builder', u'RTEMS Documentation Project', 'manual'),
    13 ]
     8latex_documents = [('index',
     9                    'rsb.tex',
     10                    u'RTEMS Source Builder',
     11                    u'RTEMS Documentation Project',
     12                    'manual')]
  • rtemsconfig/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '1.0'
    7 release = '5.0'
    8 
    9 latex_documents = [
    10         ('index', 'rtemsconfig.tex', u'RTEMS RTEMS Config Documentation', u'RTEMS Documentation Project', 'manual'),
    11 ]
    12 
     6latex_documents = [('index',
     7                    'rtemsconfig.tex',
     8                    u'RTEMS RTEMS Config Documentation',
     9                    u'RTEMS Documentation Project',
     10                    'manual')]
  • shell/conf.py

    rc2c29d8 r8127604  
    44from conf import *
    55
    6 version = '4.11.0'
    7 release = '4.11.0'
    8 
    96project = "RTEMS Shell Manual"
    107
    11 latex_documents = [
    12         ('index', 'shell.tex', u'RTEMS Shell Documentation', u'RTEMS Documentation Project', 'manual'),
    13 ]
     8latex_documents = [('index',
     9                    'shell.tex',
     10                    u'RTEMS Shell Documentation',
     11                    u'RTEMS Documentation Project',
     12                    'manual')]
  • user/conf.py

    rc2c29d8 r8127604  
    33
    44from conf import *
    5 
    6 version = '4.11.0'
    7 release = '4.11.0'
    85
    96project = "RTEMS User Manual"
     
    4037                    'waf/index.rst']
    4138
    42 latex_documents = [
    43         ('index', 'user.tex', u'RTEMS User Manual', u'RTEMS Documentation Project', 'manual'),
    44 ]
     39latex_documents = [('index',
     40                    'user.tex',
     41                    u'RTEMS User Manual',
     42                    u'RTEMS Documentation Project',
     43                    'manual')]
  • wscript

    rc2c29d8 r8127604  
    1010import waf as docs_waf
    1111
    12 version = '4.11 (4.11.2)'
     12version = '4.11 (branch)'
    1313
    1414build_all = ['user',
     
    3030
    3131def configure(conf):
     32    conf.env.VERSION = version
    3233    for b in building:
    3334        conf.recurse(b)
     
    3536
    3637def catalogue(ctx):
    37     docs_waf.xml_catalogue(ctx, building, version)
     38    docs_waf.xml_catalogue(ctx, building)
    3839
    3940def coverpage_js(ctx):
Note: See TracChangeset for help on using the changeset viewer.