Skip to content

Commit 6fc50fe

Browse files
committed
add doc for modified attribute
1 parent a1cd058 commit 6fc50fe

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

source/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
# General information about the project.
4343
project = u'Scripter2: The Scripting Engine for Scribus'
44-
copyright = u'2012, Scribus Team'
44+
copyright = u'2013, Scribus Team'
4545

4646
# The version info for the project you're documenting, acts as replacement for
4747
# |version| and |release|, also used in various other places throughout the
@@ -91,7 +91,7 @@
9191

9292
# The theme to use for HTML and HTML Help pages. See the documentation for
9393
# a list of builtin themes.
94-
html_theme = 'default'
94+
html_theme = 'sphinxdoc'
9595

9696
# Theme options are theme-specific and customize the look and feel of a theme
9797
# further. For a list of options available for each theme, see the

source/docs/documentapi.rst

+12
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,20 @@
3232

3333
.. py:attribute:: DocumentAPI.margins
3434
35+
Return an object of type :class:`Margins`
36+
3537
.. py:attribute:: DocumentAPI.modified
3638
39+
This attribute is used to check whether the document is modified or not. It can also be used to set a document as modified.::
40+
41+
>>> doc = Scripter.activeDocument
42+
>>> doc.modified
43+
False
44+
>>> doc.modified = True
45+
>>> doc.modified
46+
True
47+
>>>
48+
3749
.. py:attribute:: DocumentAPI.activePage
3850
3951
.. py:attribute:: DocumentAPI.pageCount

0 commit comments

Comments
 (0)