X Tutup
Skip to content

Commit 1cb9892

Browse files
author
Steve Canny
committed
docs: reorganize documentation
1 parent ddaa7ad commit 1cb9892

File tree

22 files changed

+315
-197
lines changed

22 files changed

+315
-197
lines changed

‎.gitignore‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.coverage
2-
dist
3-
doc/_build
4-
*.egg-info
2+
/dist/
3+
/docs/.build/
4+
/*.egg-info
55
*.pyc
6-
_scratch
6+
_scratch/
77
Session.vim
8-
.tox
8+
/.tox/

‎HISTORY.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. :changelog:
2+
3+
Release History
4+
---------------
5+
6+
0.3.0dev1 (2013-12-14)
7+
++++++++++++++++++++++
8+
9+
- Round-trip .docx file, preserving all parts and relationships
10+
- Load default "template" .docx on open with no filename
11+
- Open from stream and save to stream (file-like object)
12+
- Add paragraph at and of document
13+

‎README.rst‎

Lines changed: 5 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,8 @@
1-
###########
2-
python-docx
3-
###########
41

5-
VERSION: 0.3.0d1 (first development release)
2+
*python-docx* is a Python library for creating and updating Microsoft Word
3+
(.docx) files.
64

5+
More information is available in the `python-docx documentation`_.
76

8-
STATUS (as of July 29 2013)
9-
===========================
10-
11-
First development release. Under active development.
12-
13-
14-
Vision
15-
======
16-
17-
18-
Documentation
19-
=============
20-
21-
Documentation is hosted on Read The Docs (readthedocs.org) at
22-
https://python-docx.readthedocs.org/en/latest/.
23-
24-
25-
Reaching out
26-
============
27-
28-
We'd love to hear from you if you like |pd|, want a new feature, find a bug,
29-
need help using it, or just have a word of encouragement.
30-
31-
The **mailing list** for |pd| is (google groups ... )
32-
33-
The **issue tracker** is on github at `python-openxml/python-docx`_.
34-
35-
Feature requests are best broached initially on the mailing list, they can be
36-
added to the issue tracker once we've clarified the best approach,
37-
particularly the appropriate API signature.
38-
39-
.. _`python-openxml/python-docx`:
40-
https://github.com/python-openxml/python-docx
41-
42-
43-
Installation
44-
============
45-
46-
|pd| may be installed with ``pip`` if you have it available::
47-
48-
pip install python-docx
49-
50-
It can also be installed using ``easy_install``::
51-
52-
easy_install python-docx
53-
54-
If neither ``pip`` nor ``easy_install`` is available, it can be installed
55-
manually by downloading the distribution from PyPI, unpacking the tarball,
56-
and running ``setup.py``::
57-
58-
tar xvzf python-docx-0.0.1d1.tar.gz
59-
cd python-docx-0.0.1d1
60-
python setup.py install
61-
62-
|pd| depends on the ``lxml`` package. Both ``pip`` and ``easy_install`` will
63-
take care of satisfying that dependency for you, but if you use this last
64-
method you will need to install ``lxml`` yourself.
65-
66-
67-
Release History
68-
===============
69-
70-
July 29, 2013 - v0.3.0d1
71-
* Establish initial enviornment and development branches
72-
73-
74-
License
75-
=======
76-
77-
Licensed under the `MIT license`_. Short version: this code is copyrighted by
78-
me (Steve Canny), I give you permission to do what you want with it except
79-
remove my name from the credits. See the LICENSE file for specific terms.
80-
81-
.. _MIT license:
82-
http://www.opensource.org/licenses/mit-license.php
83-
84-
.. |pd| replace:: ``python-docx``
7+
.. _`python-docx documentation`:
8+
https://python-docx.readthedocs.org/en/latest/

‎doc/developer/analysis/ct_document.rst‎

Lines changed: 0 additions & 95 deletions
This file was deleted.

doc/Makefile renamed to docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
PAPER =
8-
BUILDDIR = _build
8+
BUILDDIR = .build
99

1010
# Internal variables.
1111
PAPEROPT_a4 = -D latex_paper_size=a4

doc/_static/.gitignore renamed to docs/_static/.gitignore

File renamed without changes.

doc/_themes/armstrong/LICENSE renamed to docs/_themes/armstrong/LICENSE

File renamed without changes.

doc/_themes/armstrong/layout.html renamed to docs/_themes/armstrong/layout.html

File renamed without changes.

doc/_themes/armstrong/rtd-themes.conf renamed to docs/_themes/armstrong/rtd-themes.conf

File renamed without changes.

doc/_themes/armstrong/static/rtd.css_t renamed to docs/_themes/armstrong/static/rtd.css_t

File renamed without changes.

0 commit comments

Comments
 (0)
X Tutup