Initial attempt at documentation #20

Merged
merged 8 commits into from May 24, 2012

Projects

None yet

2 participants

@pekkle01
Member

Initial commit of documentation in Sphinx-compatible format. Creation of new 'doc' directory to store documentation (source files). First attempt at Sphinx-source files for ATOMac documentation.

Future work will include expanding on this, actually generating the documentation, and updating the docstrings in the code to be uniform and consistent.

Initial documentation content is a lightly revised version of what is available on the home page for the project here:

https://github.com/pyatom/pyatom

Feedback greatly appreciated.

Thanks!

@pekkle01 pekkle01 Initial commit of documentation in Sphinx-compatible format.
Initial commit of documentation in Sphinx-compatible format.  Creation of new 'doc' directory to store documentation (source files).  First attempt at docs for ATOMac.  Future work will include expanding on this, actually generating the documentation, and updating the docstrings in the code to be uniform and consistent.
f8de9e9
@pekkle01
Member

To generate the html docs, within the 'doc' directory type:

$ make html

Additionally, does anyone know how not to require the _static and _templates directories? I'd created empty files in them to include them so that the Makefile wouldn't choke (I could have edited the Makefile itself too I suppose).

Thanks!

pekkle01 added some commits Sep 8, 2011
@pekkle01 pekkle01 Cleaned up some of the documentation references to pyatom (converted …
…to atomac / ATOMac).
97a1010
@pekkle01 pekkle01 Initial attempt at documentation for ATOMac. 52d5c8c
@pekkle01 pekkle01 Merge commit 'upstream/master' 16c3178
@pekkle01 pekkle01 Cleaned up directories for initial documentation submission.
Removed unwanted gitignore files from auto-generated directories.
56bd684
@pekkle01 pekkle01 Update conf.py and apireference.rst
Update conf.py to support version auto-updating
Update apireference.rst for autodocumenting from docstrings.

Note: For the autodocumenting to work, the user currently must
first run setup.py build to build the _a11y extension, then
run the sphinx command to build the docs.
7622f17
@pekkle01 pekkle01 Remove an unnecessary import
Forgot to remove an import of distutils.core that is currently
not needed.
46020a6
@pekkle01 pekkle01 Address issue in which escaped characters are not handled properly.
If a user were to use sendKey() or sendKeys() to send a character or string
that contained escaped characters (e.g. '\t' or '\n'), the escaped character
would result in an exception because it could not be found in the keyboard
constants.

This change attempts to address this by mapping the escaped characters to
their keyboard constant equivalents.

Note that this particular change does not include the entire set of
escape sequences recognized by Python.

Testing done:
-------------

>>> import os, sys, time
>>> import atomac
NOTE:  This import was conducted after
 a `python setup.py build` was issued at the shell
 and the import made above the atomac directory
 in the build directory

>>> a = atomac.getAppRefByLocalizedName('Terminal')
a.s>>> a.sendKeys('hello')
hello>>> hello
KeyboardInterrupt
>>> a.sendKeys('hello\nthere')
hello
there>>> hello
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'hello' is not defined
>>> there
KeyboardInterrupt
>>> a.sendKeys('hello\rthere')
hello
there>>> hello
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'hello' is not defined
>>> a.sendKeys('hello\r\nthere')
hello

there>>> hello
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'hello' is not defined
>>>
>>> there
KeyboardInterrupt
>>> a.sendKeys('hello\tthere')
hello	there>>> hello       there
KeyboardInterrupt
>>> a.sendKeys('hello\tthere')
KeyboardInterrupt
>>> a.sendKey('\n')

>>>
>>> a.sendKeys('\n\n\n\n\n')

>>>
>>>
>>>
>>>
>>>
>>> a.sendKeys('\t\t\t\t\t')
					>>>
KeyboardInterrupt
8b9ccf1
@pekkle01
Member

Hmmm ... this pull request has been sitting for a while; I recall making a few updates to the doc pull request a month or so ago.

However, my latest commit to my repository seeks to address Issue #22.

Is there a way to isolate this change / pull request from the documentation one?

@jtatum
Member
jtatum commented May 24, 2012

Built docs look great. I think there are definitely changes we can make but for now let's just merge, get it posted and work on any updates in subsequent proposals.

@jtatum jtatum merged commit 80645b8 into pyatom:master May 24, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment