Changeset ac0eaff in rtems-docs


Ignore:
Timestamp:
Nov 13, 2017, 12:51:23 AM (2 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
master
Children:
3384994
Parents:
6c56401
Message:

Use '.. toctree::' and not '.. include::' in the User Manual.

  • Change all suitable '.. include::' to TOC tree.
  • Remove unused and not needed sections.
  • Fix the conf.py to not exclude some files.

Close #3232.

Location:
user
Files:
10 deleted
7 edited

Legend:

Unmodified
Added
Removed
  • user/conf.py

    r6c56401 rac0eaff  
    55
    66project = "RTEMS User Manual"
    7 
    8 exclude_patterns = ['config/build.rst',
    9                     'config/runtime.rst',
    10 
    11                     'start/quick.rst',
    12 
    13                     'hosts/os.rst',
    14                     'hosts/prefixes.rst',
    15                     'hosts/macos.rst',
    16                     'hosts/posix.rst',
    17                     'hosts/windows.rst',
    18 
    19                     'installation/prefixes-sandboxing.rst',
    20                     'installation/releases.rst',
    21                     'installation/developer.rst',
    22                     'installation/kernel.rst',
    23 
    24                     'hardware/targets.rst',
    25                     'hardware/architectures.rst',
    26                     'hardware/bsps.rst',
    27                     'hardware/tiers.rst',
    28 
    29                     'tools/build.rst',
    30                     'tools/simulation.rst',
    31 
    32                     'test/create.rst',
    33                     'test/running.rst',
    34                     'start/installation.rst',
    35                     'start/transition.rst',
    36 
    37                     'waf/index.rst']
    387
    398latex_documents = [
  • user/hardware/index.rst

    r6c56401 rac0eaff  
    1313Packages, and running RTEMS on real hardware and simulators.
    1414
    15 .. include:: targets.rst
    16 .. include:: architectures.rst
    17 .. include:: bsps.rst
    18 .. include:: tiers.rst
     15.. toctree::
     16
     17   targets
     18   architectures
     19   bsps
     20   tiers
  • user/hosts/index.rst

    r6c56401 rac0eaff  
    4545can happen and for the ARM architecture and with all BSPs it can be many hours.
    4646
    47 .. include:: os.rst
    48 .. include:: posix.rst
    49 .. include:: macos.rst
    50 .. include:: windows.rst
     47.. toctree::
     48
     49   os
     50   posix
     51   macos
     52   windows
  • user/index.rst

    r6c56401 rac0eaff  
    5454
    5555        support/index
    56         additional/index
     56
    5757        glossary/index
    5858
  • user/installation/index.rst

    r6c56401 rac0eaff  
    44.. comment: All rights reserved.
    55
     6.. index:: Installation
    67.. _installation:
    78
    89Installation
    910************
    10 .. index:: Installation
    1111
    1212This section details how to set up and install the RTEMS Ecosystem. You will
     
    4343repositories for the tools and kernel.
    4444
    45 .. include:: prefixes-sandboxing.rst
    46 .. include:: releases.rst
    47 .. include:: developer.rst
    48 .. include:: kernel.rst
     45.. comment: code block warning is in kernel.rst
    4946
    50 .. comment: code block warning is in kernel.rst
     47.. toctree::
     48
     49   prefixes-sandboxing
     50   releases
     51   developer
     52   kernel
  • user/installation/prefixes-sandboxing.rst

    r6c56401 rac0eaff  
    55
    66.. _prefixes:
     7.. index:: Prefixes
    78
    89Prefixes
    910========
    10 
    11 .. index:: Prefixes
    1211
    1312You will see the term :ref:term:`prefix` referred to thoughout this
  • user/tools/index.rst

    r6c56401 rac0eaff  
    1515developers.
    1616
    17 .. include:: linker.rst
    18 .. include:: symbols.rst
    19 .. include:: exeinfo.rst
    20 .. include:: trace-linker.rst
    21 .. include:: bsp-builder.rst
    22 .. include:: tester.rst
     17.. toctree::
     18
     19   linker
     20   symbols
     21   exeinfo
     22   trace-linker
     23   bsp-builder
     24   tester
Note: See TracChangeset for help on using the changeset viewer.