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

Adding MkDocs docs to template #319

Merged
merged 25 commits into from
Mar 25, 2024
Merged

Adding MkDocs docs to template #319

merged 25 commits into from
Mar 25, 2024

Commits on Mar 20, 2024

  1. Adding MkDocs docs to template

    @matt-graham
    matt-graham committed Mar 20, 2024
    Configuration menu
    Copy the full SHA
    a5f0d52 View commit details
    Browse the repository at this point in the history

  2. Add new line in docstring to satisfy Ruff

    @matt-graham
    matt-graham committed Mar 20, 2024
    Configuration menu
    Copy the full SHA
    36a4fbd View commit details
    Browse the repository at this point in the history

Commits on Mar 21, 2024

  1. Avoid repetition of docs dependencies

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    d33e871 View commit details
    Browse the repository at this point in the history

  2. Fix typo and make title case consistent

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    d605092 View commit details
    Browse the repository at this point in the history

  3. Format frameworks as a list

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    ec12b11 View commit details
    Browse the repository at this point in the history

  4. Add edit URI for GitHub links

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    788c9f7 View commit details
    Browse the repository at this point in the history

  5. Use MkDocs recommended stricter validation

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    ebebf85 View commit details
    Browse the repository at this point in the history

  6. Add GitHub social link

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    0de39ae View commit details
    Browse the repository at this point in the history

  7. Include README and license content in docs

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    81fa625 View commit details
    Browse the repository at this point in the history

  8. Tweak copyright line

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    248f1f3 View commit details
    Browse the repository at this point in the history

  9. Correct reference to docs dependencies

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    0648c3a View commit details
    Browse the repository at this point in the history

  10. Rename license file in docs to make relative link from README work

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    04884a5 View commit details
    Browse the repository at this point in the history

  11. Add edit buttons to docs

    @matt-graham
    matt-graham committed Mar 21, 2024
    Configuration menu
    Copy the full SHA
    f16841b View commit details
    Browse the repository at this point in the history

Commits on Mar 22, 2024

  1. Merge branch 'main' into mmg/mkdocs-docs

    @paddyroddy
    paddyroddy authored Mar 22, 2024
    Configuration menu
    Copy the full SHA
    414fd18 View commit details
    Browse the repository at this point in the history

  2. Apply suggestions from code review 

    Co-authored-by: Patrick J. Roddy <patrickjamesroddy@gmail.com>
    @matt-graham @paddyroddy
    matt-graham and paddyroddy authored Mar 22, 2024
    Configuration menu
    Copy the full SHA
    442992e View commit details
    Browse the repository at this point in the history

  3. Reorder tox testenv sections 

    Co-authored-by: Patrick J. Roddy <patrickjamesroddy@gmail.com>
    @matt-graham @paddyroddy
    matt-graham and paddyroddy committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    2e67533 View commit details
    Browse the repository at this point in the history

  4. Add quotation marks around URL for consistency

    @matt-graham
    matt-graham committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    f48174e View commit details
    Browse the repository at this point in the history

  5. Add vertical spacing between docs workflow job steps for consistency 

    Co-authored-by: Patrick J. Roddy <patrickjamesroddy@gmail.com>
    @matt-graham @paddyroddy
    matt-graham and paddyroddy committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    483a19e View commit details
    Browse the repository at this point in the history

  6. Adjust commented section indentation

    @matt-graham
    matt-graham committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    2f6bace View commit details
    Browse the repository at this point in the history

  7. Remove spaces on empty lines

    @matt-graham
    matt-graham committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    c36eb4f View commit details
    Browse the repository at this point in the history

  8. Add option to enable automatically docs to GitHub Pages to cookiecutter

    @matt-graham
    matt-graham committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    dfa918a View commit details
    Browse the repository at this point in the history

  9. Adjust newlines and whitespace control in template to satisfy prettier

    @matt-graham
    matt-graham committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    5c874cf View commit details
    Browse the repository at this point in the history

  10. Switch from pymdownx.snippets extension to mkdocs-include-markdown-pl… 

    …ugin
    @matt-graham
    matt-graham committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    c23d7e6 View commit details
    Browse the repository at this point in the history

  11. Remove indentation in include-markdown directive to satisfy prettier

    @matt-graham
    matt-graham committed Mar 22, 2024
    Configuration menu
    Copy the full SHA
    832b262 View commit details
    Browse the repository at this point in the history

Commits on Mar 25, 2024

  1. Update {{cookiecutter.project_slug}}/README.md 

    Co-authored-by: Sam Cunliffe <samcunliffe@users.noreply.github.com>
    @matt-graham @samcunliffe
    matt-graham and samcunliffe authored Mar 25, 2024
    Configuration menu
    Copy the full SHA
    fbb1d62 View commit details
    Browse the repository at this point in the history