Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs (User + Design Guides) conversion to Sphinx #2910

Merged
merged 14 commits into from
Jan 22, 2019
Merged

Docs (User + Design Guides) conversion to Sphinx #2910

merged 14 commits into from
Jan 22, 2019

Commits on Jan 18, 2019

  1. Minimal conversion of User and Suite Design Guides to Sphinx 

    Configure Sphinx documentation builder
Copy all CUG & SDG text & split into .rst files w/ better sectioning
Convert all text content from TeX to RST
Create basic docs-building wrapper command 'make-docs'
    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    5eeb54f View commit details
    Browse the repository at this point in the history

  2. Revert to original sectioning structure

    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    cb9f5bd View commit details
    Browse the repository at this point in the history

  3. Amend documentation-related commands; get numbered figures working 

    Update 'cylc make-docs' & 'cylc documentation' accordingly
Add numfig extension to get numerical figure refs in Sphinx 1.2.x
    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    5d82c7d View commit details
    Browse the repository at this point in the history

  4. Add-in CLI content via auto-generation & '/etc/examples/' includes

    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    f2d403e View commit details
    Browse the repository at this point in the history

  5. Assorted updates 

    Rebase branch to updated master to include all recent changes
Amend Cylc homepage 'index' page
Amend .gitignore to include all generated docs content
Amend documentation/00-make.t to account for new make method
Amend relevant tests to account for changed [documentation][files]
    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    3868421 View commit details
    Browse the repository at this point in the history

  6. Respond to cylc#2910 feedback, esp. amending to higher sphinx version 

    Adapt for clean build with sphinx version range >= 1.5.3, <= 1.7.9:
  * apply available built-in to remove external extension numfig
  * "classic" theme now hardcoded as required for these versions
Fix literals inside bold & (amendable) cylc_lang lexer error cases
Update 'check-software' command & installation instruction text
Remove redundant files (auto_cli_doc.py, make-index.sh)
    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    1680de8 View commit details
    Browse the repository at this point in the history

  7. Adapt strictly invalid code snippets picked up by fixed lexer

    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    083096a View commit details
    Browse the repository at this point in the history

  8. Update with changes to docs (converted to RST) from cylc#2815 merge

    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    01cee3f View commit details
    Browse the repository at this point in the history

  9. Update with changes to docs (converted to RST) from cylc#2922 merge

    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    a82061a View commit details
    Browse the repository at this point in the history

  10. Respond to later cylc#2910 feedback by making minor updates

    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    0589189 View commit details
    Browse the repository at this point in the history

  11. Update with changes to docs (converted to RST) from cylc#2924 merge

    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    60098c1 View commit details
    Browse the repository at this point in the history

  12. Update with changes to docs (converted to RST) from cylc#2930 merge

    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    86d503d View commit details
    Browse the repository at this point in the history

  13. From self-review: auto-generate all Cylc version references

    @sadielbartholomew
    sadielbartholomew committed Jan 18, 2019
    Configuration menu
    Copy the full SHA
    aec7d21 View commit details
    Browse the repository at this point in the history

Commits on Jan 21, 2019

  1. Respond to latest cylc#2910 feedback with minor changes

    @sadielbartholomew
    sadielbartholomew committed Jan 21, 2019
    Configuration menu
    Copy the full SHA
    faf53d7 View commit details
    Browse the repository at this point in the history