-
Notifications
You must be signed in to change notification settings - Fork 132
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
Issue #269 update actionkit connector docs #313
Issue #269 update actionkit connector docs #313
Conversation
I based my changes off existing examples, but I'm not sure if my |
@rgriff23 there should be a way to build the docs locally and inspect your changes there, but it's not been written down yet (and I personally don't know it). For now the docs just link to the sphinx guide for rebuilding but I wasn't able to get that working myself so I'm not sure how helpful it will be. Hopefully @eliotst or @SorenSpicknall can get us the right process. At least on a content level, your updates look fantastic. We finally have our "model connector docs" we can point to and say "make your documentation look like this!" |
For creating docs internally you need two packages:
Then to build do the following:
It will generate all of the html locally that you can then inspect. If there are recommendations as to how to better systematize this, I'm open to it. The html files shouldn't be included in the commit though, as they are built on deploy. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! Thank you so much for making these changes. Just a couple of small things.
docs/action_kit.rst
Outdated
@@ -5,19 +5,53 @@ ActionKit | |||
Overview | |||
******** | |||
|
|||
The ActionKit class allows you to interact with an `ActionKit <https://actionkit.com/>`_. | |||
`ActionKit <https://actionkit.com/>`_ is a platform for advocacy, fundraising, and | |||
get-out-the-vote. This parsons integration with the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small thing: we capitalize "Parsons" when referencing the name of the library in documentation.
docs/action_kit.rst
Outdated
|
||
********** | ||
Quickstart | ||
********** | ||
|
||
**Retrieve a User** | ||
To instantiate the ActionKit class, you can either store your ActionKit API | ||
domain, username, and password as environmental variables (ACTION_KIT_DOMAIN, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another minor thing.. could you wrap the environment variables' names in double backticks (e.g. ``ACTION_KIT_DOMAIN``) so they are formatted as code?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks again!
Thanks so much @rgriff23! I updated issue 269 to use the actionkit connector as the new model. :) |
@jburchard @shaunagm I also had to install |
This PR updates connector documentation for the ActionKit class, per issue #269.
Change summary:
*.rst
, aiming to following the examples provided in the issue description as closely as possible**kwargs
documentation, making it consistent and correct across functionsAll tests passed