1. 21 Jun, 2019 1 commit
    • Leona C's avatar
      Documentation updates for 0.21.0 (#3010) · b8056257
      Leona C authored
      * WIP more guides and tutorials for the docs
      
      * Update Guides and structure
      
      * Update Guides and structure
      
      + Test documentation build on Clear Linux OS;
      + Fix a few links and redirs.
      + Note rc-naming conventions in doc may be tag-generalized.
      
      * documentation supports various rc-naming conventions
      
      * Add instructions on building nGraph bridge from src
      
      * Update ngtf bridge versions to 0.14.1 and TensorFlow's bazel dependency to 0.24.1
      
      * Use consistent file naming on all BE indexes
      
      * Fix comma
      
      * Templatize versioning for releases starting 0.20 and add placeholders for changes by components
      
      * Remove typo
      
      * Minor formatting fixed
      
      * Document how to find or display built version of nGraph
      
      * Start a r0.21 for doc that also fixes broken link and typo
      
      * Correct use of console command context for version check
      
      * Minor fixes to doc-contributor-README
      
      * Docs for version 0.21
      
      * Ensure docs build without error
      
      * Assign ownership project README and intro for new ngraph.ai site to Straw
      
      * Note deprecated Tensor API in doc
      
      * Update to generic versioning on core doc for importing via built wheels
      
      * Resolve merge conflicts leftover from v20 version request changes
      
      * remove typo and suggested use of prebuilt LLVM since newer OSes do not have them available
      
      * Update to latest
      
      * Update with review from PR and ngraph bridge team
      
      * Update right section with review from PR and ngraph bridge team
      
      * Ensure doc example folders have owners from the component
      
      * Push edit of tensorflow_connect to v0.22 docs
      
      * Update Python wheel building instructions to newer version
      b8056257
  2. 08 May, 2018 1 commit
    • Adam Rogowiec's avatar
      [Py] (Partially) automatic generation of python API doc (#973) · 11ec6449
      Adam Rogowiec authored
      * First version of nGraph Python API documentation pages.
      
      * Remove use of (`) apostrophes since they generate Sphinx warnings.
      
      * Fix submodule rendering in Sphinx PythonAPI docs
      
      * Add updated index and conf py files
      
      * Updated version of Python API doc.
      
      * Better description for the autosummary
      
      * FIX: Disable autogeneration of summary files in documentation.
      
      * Remove redundant file containing duplicate information.
      
      * Remove unused Sphinx extensions.
      
      * (Partially) automatic generation of python API doc.
      
      - Detailed documentation is generated automatically
      - Summaries are generated automatically for all files except runtime.py
        which is parsed incorrectly.
      - No additional steps required. Only run `make html`. Under the hood there
        is lunched script which generates all required files to some temporary
        directory under `/tmp/sphinx_auto_py_doc/` and copied to docs directory
        afterwards.
      - Remove `autosummary_generate` from in configuration file since we use
        custom script which performs this step.
      
      * Review update.
      
      * Automatically generated stub files for doc.
      
      - Added just few empty lines which has been removed during recent merge.
      11ec6449