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

Speed up doc builds & improve documentation #198

Merged
merged 17 commits into from
May 19, 2020
Merged

Speed up doc builds & improve documentation #198

merged 17 commits into from
May 19, 2020

Commits on May 19, 2020

  1. Speed up documentation build for non-deployments 

     - Change documentation scope to only public and protected entities
   - May need to manually document available overloaded interfaces
 - Reduce MAXRANK from 4 to 3
 - Don't generate search index for non-deployed builds
 - Don't generate graphs for non-deployed builds
    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    24887d5 View commit details
    Browse the repository at this point in the history

  2. Ignore "colour" in misspell check

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    a656934 View commit details
    Browse the repository at this point in the history

  3. Update README to point to documentation

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    e1f4a08 View commit details
    Browse the repository at this point in the history

  4. Ask people to document code w/ FORD in WORKFLOW.md

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    f2306af View commit details
    Browse the repository at this point in the history

  5. Duplicate informational files in FORD 

     Use the Markdown Include functionality to duplicate the workflow, style, License, etc. in FORD "Pages" documentation.
    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    430ca51 View commit details
    Browse the repository at this point in the history

  6. Documentation: Improve the specs landing page 

    - Links added to existing specs
- Some modules are still missing specs
    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    99d0f98 View commit details
    Browse the repository at this point in the history

  7. Doc: Better section name in STYLE_GUIDE.md

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    a2dfb48 View commit details
    Browse the repository at this point in the history

  8. Doc: Format STYLE_GUIDE play nice w/ GFM & PyMD 

    - Try to format some code in such a way that the rendering is OK with GFM and python markdown (FORD)
    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    8b25413 View commit details
    Browse the repository at this point in the history

  9. Update WORKFLOW.md w/ link to specs doc online

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    ba5f87c View commit details
    Browse the repository at this point in the history

  10. Add warning & todo to main FORD pages directory

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    5599033 View commit details
    Browse the repository at this point in the history

  11. Doc: Add todo section for missing specs 

    - Next step: enumerate the missing specs
- Then: write missing specs
    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    18f4845 View commit details
    Browse the repository at this point in the history

  12. Improve experimental_error doc & link w/ spec 

    This commit improves the inline FORD documentation of experimental_error
and provides some examples of how to use the FORD linking syntax in the spec.
    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    24f6b3e View commit details
    Browse the repository at this point in the history

  13. CI: Attempt to fix documentation build

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    96afebd View commit details
    Browse the repository at this point in the history

  14. Fix artifact upload path

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    fa6d0f8 View commit details
    Browse the repository at this point in the history

  15. Fix broken spelling PR review

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    7732497 View commit details
    Browse the repository at this point in the history

  16. CI: fix attempt fortran-lang#2 for PR spelling review

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    44a44f7 View commit details
    Browse the repository at this point in the history

  17. Fix typo

    @zbeekman
    zbeekman committed May 19, 2020
    Configuration menu
    Copy the full SHA
    1bb21d9 View commit details
    Browse the repository at this point in the history