Anonymous avatar Anonymous committed e9addb7

Separated docs for different packages

Comments (0)

Files changed (5)

docs/dev/workingon.txt

 Plans For New Packages
 ======================
 
-* Separating docs for different packages; different ``README.txt``\s?
 * Updating docs
 
-===========================  =============================
-Filename                     Belongs to
-===========================  =============================
-docs/contributing.txt        all
-docs/done.txt                all
-docs/library.txt             rope, ropeide
-docs/ropemacs.txt            ropemacs
-docs/index.txt               all
-docs/overview.txt            rope, ropeide
-docs/tutorial.txt            ropeide
-===========================  =============================
-
 
 ropemacs Mode
 =============

docs/ropemacs.txt

  ropemacs, rope in emacs
 =========================
 
-Using rope in emacs.
+Using rope in emacs.  You should install `rope`_ library before using
+ropemacs.
+
+.. _`rope`: http://rope.sf.net/
 
 
 Setting Up
 Uses the same keybinding as in rope.
 
 
+Getting Started
+===============
+
+* List of features: `docs/index.txt`_
+* Contributing: `docs/contributing.txt`_
+
+.. _`docs/index.txt`: docs/index.html
+.. _`docs/contributing.txt`: docs/contributing.html
+
+
 License
 =======
 

tools/rope_MANIFEST.in

 include README.txt COPYING setup.py MANIFEST.in
-include docs/*.html
-include docs/*.txt
+include docs/contributing.txt docs/done.txt docs/library.txt
+include docs/index.txt docs/overview.txt
 
 recursive-include rope *.py
 recursive-include ropetest *.py

tools/ropeide_MANIFEST.in

 include README.txt COPYING rope.py setup.py MANIFEST.in
-include docs/*.html
-include docs/*.txt
+include docs/contributing.txt docs/done.txt docs/library.txt
+include docs/index.txt docs/overview.txt docs/tutorial.txt
 
 recursive-include ropeide *.py
 recursive-include ropeidetest *.py

tools/ropemacs_MANIFEST.in

 include README.txt COPYING setup.py MANIFEST.in
-include ropemacs.py docs/ropemacs.txt
+include docs/contributing.txt docs/done.txt docs/index.txt
+include ropemacs.py
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.