📝 CLI Documentation Formatting

[dhuppenkothen]

Description

[//]: # Changed triple quotes to single quotes for help text in --equipment-id in cli.py. This now matches other help texts spanning multiple lines, and should fix the issue with compiling the options into a table.
[//]: # The options in the CLI documentation under "Campsites" does not compile correctly: from --equipment-id onwards, the table seems to break. This change hopefully fixes that issue and puts everything into their appropriate table.

Has This Been Tested?

[//]: # Unfortunately, I couldn't quite figure out how to compile the documentation on my own system, so that hasn't been tested yet. Happy to do so if the maintainers give me a pointer for how to compile the documentation. :)

Checklist:

• [x ] I've read the contributing guidelines of this project
• [ x] I've installed and used .pre_commit on all my code
• [ x] I have documented my code, particularly in hard-to-understand areas
• [ x] I have made any necessary corresponding changes to the documentation

[juftin]

🏕️ thank you!!

You can generate the documentation locally with mkdocs (even easier, run it from within a poetry virtualenv with all the extra dependencies installed):

poetry install
poetry run mkdocs serve

I will get a chance to take a look at this myself soon.

[juftin]

Before Change:

After Change:

[juftin]

We're missing one small bit of whitespace here after "unique to it." See the screenshot @ #185 (comment)

[juftin]

Okay - other than the whitespace comment above this looks good. There are a couple changes we'll need to make in order for this to deploy properly:

1. When we finally commit this to main we'll need the commit message to conform to GitMoji. Performing a Squash Commit and titling it 📝 Fix formatting of options under campsites on CLI documentation will work (and I'll handle this when I push the merge button). There's some more info here on the commits/release rules here.

2. Update the docs CI job to run on pushes instead of releases (since documentation changes don't trigger a new release). The code here will change to this:

on:
    push:
        branches: ['main']
        paths:
        -   camply/**
        -   docs/**
        -   .github/workflows/docs.yaml
        -   mkdocs.yml

I'm happy to handle this myself as well, let me know what works for you.

[juftin]

🎉 This PR is included in version 0.9.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀