SourceForge logo
SourceForge logo
Menu

Re: [matplotlib-devel] future of mpl documentation

From: John H. <jd...@gm...> - 2008年05月22日 18:05:15
On Thu, May 22, 2008 at 12:48 PM, Darren Dale <dar...@co...> wrote:
> You're right, that sounds easier. Here's a taste, it has a bit taken from the
> users guide, I marked up the CODING_GUIDE, and I used the autodoc extension
> to document the API of texmanager and dviread:
How do you envision putting this together? Will each of these
documents (eg CODING_GUIDE) live as separate rest files and are then
included in one doc? I don't think we will want to have one master
PDF for the user's guide, developer's guide and api docs (the
autogenerated api docs at http://matplotlib.sf.net/api.pdf are 560
pages along). Did you do any rest conversion of the texmanager and
dviread, or did autodoc do everything? I'd like to get a feel for
what the rest markup of the docstrings will look like.
In any case, this is exciting, since I am eager to have a nice rest
based doc system. You might want to look at incorporating the three
rest docs in the doc subdir: artist_api_tut.txt,
event_handling_tut.txt and devel/add_new_projection.rst since these
are already done. I guess we also need to standardize on rst vs txt
extensions. I think txt is friendlier to windoze users, and I have my
emacs to use rest mode for *.txt
(require 'rst)
(autoload 'rst-mode "rst-mode" "mode for editing reStructuredText documents" t)
(setq auto-mode-alist
 (append '(
		 ("\\.txt$" . rst-mode)
		 ("\\.rst$" . rst-mode)
		 ("\\.rest$" . rst-mode)) auto-mode-alist))
As you as you can, commit a working directory for the doc build and
I'll help with some of the conversion of the existing docs to rest.
We can split up the user's guide chapters, etc...
JDH

View entire thread

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X





Briefly describe the problem (required):
Upload screenshot of ad (required):
Select a file, or drag & drop file here.
Screenshot instructions:

Click URL instructions:
Right-click on the ad, choose "Copy Link", then paste here →
(This may not be possible with some types of ads)

More information about our ad policies

Ad destination/click URL:

AltStyle によって変換されたページ (->オリジナル) /