Skip to content

Fixup formatting issue with the Getting Started doc #25

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

Merged
bmedx merged 1 commit into from
Feb 4, 2019
Merged

Fixup formatting issue with the Getting Started doc #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,22 @@ In your ``source_path`` add some comments with annotations in them. Examples:
// .. annotation_token: And this!


Run a static annotation search
------------------------------
Run an annotation search
------------------------

.. code-block:: bash

$ code_annotations django_find_annotations --config_file /path/to/your/config
$ code_annotations static_find_annotations --config_file /path/to/your/config


If you have ``DJANGO_SETTINGS_MODULE`` correctly configured and have annotated some models you can also run a Django
model annotation search:

.. code-block:: bash

$ code_annotations django_find_annotations --config_file /path/to/your/config


If all went well you should see a message telling you the name of the report file that was written out. Take a look in
your favorite text editor to make sure all of your annotations were found. Different verbosity levels are available for
this command, try ``-v``, ``-vv``, and ``-vvv`` to assist in debugging. ``--help`` will provide information on all of
Expand Down