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

Rewrite the documentation #85

Merged
merged 7 commits into from
Mar 25, 2024
Merged

Rewrite the documentation #85

merged 7 commits into from
Mar 25, 2024

Commits on Mar 19, 2024

  1. Remove old documentation 

    Signed-off-by: John Pennycook <[email protected]>
    @Pennycook
    Pennycook committed Mar 19, 2024
    Configuration menu
    Copy the full SHA
    b7af834 View commit details
    Browse the repository at this point in the history

  2. Add Sphinx documentation 

    The new documentation includes:
- An introduction to Code Base Investigator
- A worked tutorial with a sample code base
- A reference page for codebasin

Signed-off-by: John Pennycook <[email protected]>
    @Pennycook
    Pennycook committed Mar 19, 2024
    Configuration menu
    Copy the full SHA
    6b1541f View commit details
    Browse the repository at this point in the history

  3. Update README and Code of Conduct 

    Signed-off-by: John Pennycook <[email protected]>
    @Pennycook
    Pennycook committed Mar 19, 2024
    Configuration menu
    Copy the full SHA
    d8412d8 View commit details
    Browse the repository at this point in the history

Commits on Mar 21, 2024

  1. Add note to etc/ directory explaining its purpose 

    Signed-off-by: John Pennycook <[email protected]>
    @Pennycook
    Pennycook committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    17f924b View commit details
    Browse the repository at this point in the history

Commits on Mar 22, 2024

  1. Align -h output with online documentation 

    - Start all descriptions with a capital letter.
- Rewrite some messages for clarity.
- Consistently use <> syntax for metavars.

Signed-off-by: John Pennycook <[email protected]>
    @Pennycook
    Pennycook committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    5fdc696 View commit details
    Browse the repository at this point in the history

  2. Use JSON code blocks for compilation databases 

    Signed-off-by: John Pennycook <[email protected]>
    @Pennycook
    Pennycook committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    123d24e View commit details
    Browse the repository at this point in the history

Commits on Mar 25, 2024

  1. Add README to docs/ 

    Signed-off-by: John Pennycook <[email protected]>
    @Pennycook
    Pennycook committed Mar 25, 2024
    Configuration menu
    Copy the full SHA
    ae283fe View commit details
    Browse the repository at this point in the history