Skip to content
This repository has been archived by the owner on Jul 29, 2019. It is now read-only.

Add template for document generation with 'jsdoc'. #3497

Merged
merged 7 commits into from
Oct 20, 2017

Commits on Sep 29, 2017

  1. Add template for document generation with 'jsdoc'.

    In essence, it defines the subdirectory `docs` as a `jsdoc` template. Benefits:
    
    - allows the usage of partials, in order to DRY common parts of the html files.
    - makes available the jsdoc-comments, for addition into the documentation.
    - enables extraction of data from the source code. For example, the list of edge endpoints `['arrow', 'bar', 'circle']` can now be extracted from the source and inserted into the documentation on generation.
    
    In this initial version, the only file that has been changed is `docs/data/dataset.html`.
    In here, partials have been added to illustrate how common page elements can be DRY'd.
    
    The template has been set up in such a way, that resource files will be copied and that html files can pass through unchanged if no special template tags (`<?js...?>`) are used. This allows for a gradual transition of the html files to templates.
    
    **Usage:**  `gulp docs`
    
    - The result files are placed in subdirectory `gen/docs/`.
    
    **NOTE:** The release procedure will have to be adjusted by adding this gulp command.
    The docs-files will then have to be taken from `gen/docs`.
    wimrijnders committed Sep 29, 2017
    Configuration menu
    Copy the full SHA
    41bef80 View commit details
    Browse the repository at this point in the history
  2. Edits to docs/README

    wimrijnders committed Sep 29, 2017
    Configuration menu
    Copy the full SHA
    5061dc4 View commit details
    Browse the repository at this point in the history

Commits on Sep 30, 2017

  1. Configuration menu
    Copy the full SHA
    c732bdf View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    6ba6a5b View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    4fc9c7f View commit details
    Browse the repository at this point in the history

Commits on Oct 1, 2017

  1. Linted the gulpfile

    wimrijnders committed Oct 1, 2017
    Configuration menu
    Copy the full SHA
    b6f71f4 View commit details
    Browse the repository at this point in the history

Commits on Oct 2, 2017

  1. Configuration menu
    Copy the full SHA
    39c1ba0 View commit details
    Browse the repository at this point in the history