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.

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

Split TribitsDevelopersGuide.* into TribitsUsersGuide.* and TribitsMaintainersGuide.* (#381) #384

Merged

Commits on Jun 25, 2021

  1. Break TribitsDevelopersGuide.* into Users and Maintainers Guides (Tri…

    …BITSPub#381)
    
    Hopefully the structure of the new setup should be obvious but I will explain
    some changes here:
    
    * Renamed base dir from 'developers_guide/' to 'guides/'.  The two new
      documents are guides/users_guide/TribitsUsersGuide.rst and
      guides/maintainers_guide/TribitsMaintainersGuide.rst.  (The latter has file
      names and line numbers for all documented macros and functions and the former
      does not.  See updated abstract and Introduction sections in both documents
      for more details.)
    
    * Split up TribitsDevelopersGuide.rst into:
       - TribitsCoreDetailedReference.rst
       - TribitsDesignConsiderations.rst
       - TribitsDevelopersGuide.rst
       - TribitsFAQ.rst
       - TribitsGuidesBody.rst
       - TribitsGuidesReferences.rst
       - TribitsHistory.rst
       - TribitsMacroFunctionDocTemplate.rst
       - TribitsPackageNotCMakePackage.rst
       - TribitsToolsDocumentation.rst
    
    * Fixed up the shared text to work for both documents.
    
    * Renamed driver generate-dev-guide.sh to generate-guides.sh and take
      arguments 'all' or 'md' or 'ug'.
    bartlettroscoe committed Jun 25, 2021
    Configuration menu
    Copy the full SHA
    fd7d3aa View commit details
    Browse the repository at this point in the history
  2. Disable generation of TribitsUsersGuide.pdf (TriBITSPub#381)

    pdflatex hangs currently.
    bartlettroscoe committed Jun 25, 2021
    Configuration menu
    Copy the full SHA
    7b6a93c View commit details
    Browse the repository at this point in the history
  3. Remove old files TribitsDevelopersGuilde.rst and Makefile (TriBITSPub…

    …#381)
    
    These are not needed anymore.  All of this has been transitioned to other
    files in the new documents.
    bartlettroscoe committed Jun 25, 2021
    Configuration menu
    Copy the full SHA
    f0a24ba View commit details
    Browse the repository at this point in the history
  4. Comment out a couple of todos

    No sense leaving these in visible text at this point.
    bartlettroscoe committed Jun 25, 2021
    Configuration menu
    Copy the full SHA
    30855db View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    0a06166 View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2021

  1. Configuration menu
    Copy the full SHA
    6941333 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    a193b8c View commit details
    Browse the repository at this point in the history