Skip to content

Commit 465a558

Browse files
author
Steve Canny
committed
docs: extract shapes feature analyses into subdir
Also, add `cleandocs` Makefile target
1 parent 5fd8b11 commit 465a558

File tree

6 files changed

+14
-20
lines changed

6 files changed

+14
-20
lines changed

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ clean:
2424
find . -type f -name \*.pyc -exec rm {} \;
2525
rm -rf dist *.egg-info .coverage .DS_Store
2626

27+
cleandocs:
28+
$(MAKE) -C docs clean
29+
2730
coverage:
2831
py.test --cov-report term-missing --cov=docx tests/
2932

docs/dev/analysis/features/shapes.rst renamed to docs/dev/analysis/features/shapes/index.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22
Shapes (in general)
33
===================
44

5-
6-
Overview
7-
--------
8-
95
A graphical object that appears in a Word document is known as a *shape*.
106
A shape can be *inline* or *floating*. An inline shape appears on a text
117
baseline as though it were a character glyph and affects the line height.
@@ -18,6 +14,16 @@ that determines the placement of the graphic. The same graphical object can be
1814
placed inline or floating by changing its container. The graphic itself is
1915
unaffected.
2016

17+
In addition to this overview, there are the following more specialized
18+
feature analyses:
19+
20+
.. toctree::
21+
:titlesonly:
22+
23+
shapes-inline
24+
shapes-inline-size
25+
picture
26+
2127

2228
MS API
2329
------

docs/dev/analysis/features/picture.rst renamed to docs/dev/analysis/features/shapes/picture.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22
Picture
33
=======
44

5-
6-
Overview
7-
--------
8-
95
Word allows a picture to be placed in a graphical object container, either an
106
inline shape or a floating shape.
117

docs/dev/analysis/features/shapes-inline-size.rst renamed to docs/dev/analysis/features/shapes/shapes-inline-size.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22
Inline shape size
33
=================
44

5-
6-
Overview
7-
--------
8-
95
The position of an inline shape is completely determined by the text it is
106
inline with, however its dimensions can be specified. For some shape types,
117
both the contained shape and the shape container specify a width and height.

docs/dev/analysis/features/shapes-inline.rst renamed to docs/dev/analysis/features/shapes/shapes-inline.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22
Inline shape
33
============
44

5-
6-
Overview
7-
--------
8-
95
Word allows a graphical object to be placed into a document as an inline
106
object. An inline shape appears as a ``<w:drawing>`` element as a child of
117
a ``<w:r>`` element.

docs/dev/analysis/index.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,10 @@ Feature Analysis
1313
features/text/index
1414
features/table/index
1515
features/styles/index
16+
features/shapes/index
1617
features/coreprops
1718
features/numbering
1819
features/sections
19-
features/shapes
20-
features/shapes-inline
21-
features/shapes-inline-size
22-
features/picture
2320

2421

2522
Schema Analysis

0 commit comments

Comments
 (0)