René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Outlining of devel/documenting_matplotlib","articleBody":"\u003c!--To help us understand and resolve your issue, please fill out the form to the best of your ability.--\u003e\r\n\u003c!--You can feel free to delete the sections that do not apply.--\u003e\r\n\r\n### Issue\r\n\r\nThis is just a todo for continuing the improvement to devel/documenting_matlab #9872.  Feel free to comment and I'll \r\n\r\nI suggest an outline as below.  Strars indicate some writing needed versus re-org.\r\n\r\nThe idea here is to explain rst first (because you need it for the rest), and then docstrings, and finally examples and tutorials.  \r\n\r\n- Getting started\r\n  - Installing dependencies\r\n  - Organization of documentation\r\n  - Building the documentation\r\n- Writing ReST pages and ReST sections of other documents.\r\n  - ** Intro: \r\n    - pure *.rst and rst in docstrings and scripts.\r\n  - ** General format and conventions\r\n    - Section name formatting\r\n  - Linking to other rst pages \r\n  - Linking to other code\r\n  - Linking to data files\r\n  - Generating inheritence diagrams\r\n  - Emacs helpers.  \r\n- Writing self-documenting docstrings\r\n  - General format\r\n  - ** Matplotlib-specific conventions (#9875)\r\n  - Function arguments\r\n  - Setters and getters\r\n  - Keyword arguments\r\n  - ** Adding example code and figures (and where the figures go).\r\n- Writing examples and tutorials\r\n  - ** Simple example\r\n  - ** Special tutorial hints \r\n    - key-image\r\n\r\nNote there is some overlap between the rst-specific stuff and the rest...\r\n\r\n\r\n","author":{"url":"https://github.com/jklymak","@type":"Person","name":"jklymak"},"datePublished":"2017-11-28T22:16:59.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/9876/matplotlib/issues/9876"}