Documentation Refactor #462
Conversation
Adds missing imports of SegmentPlot and TextPlot to api.py.
Mark index documents are orphans to silence warnings that they aren't included in any TOC.
Remove the `user_guide/resource.rst` because it only contained redundant contents and broken links. The only relevant bit of text was about the SciPy 2008 tutorial, which is covered by `chaco_tutorial.rst` so I moved some of the text there.
Either point to a different location if relevant, or straight out remove the link if it's broken.
Move the architecture_overview doc to developer_reference, and move some of the contents into the introduction document.
The fix is to import ColorMapper directly from chaco.color_mapper
…gh I'm not entirely sure we need the links in the intro at all)
… are alrady linked from home page of docs
|
@aaronayres35 i tried reviewing this PR as it is - and i'm still struggling to maintain all of the information around what is new, what has been moved - from which file to what file - and what file has been deleted because it is irrelevant/incomplete or because it's content has been moved elsewhere. Add to this all of the style fixes, i'm overwhelmed. I don't think it's a good idea to merge this PR (even now) as is. I'm not even sure what is incomplete - for which we will need/want to open issues so we can resolve them before the release. I'm unassigning you and i'm assigning myself - thanks for bringing this PR to a cleaner state. I shall take it from here. |
|
@rahulporuri My unsolicited 2 cents, given that I did a lot of the refactor before Aaron took over (thanks Aaron!). I suggest not treating it as a "diff". Like you said, it's near impossible to keep track off, the old docs were old. Instead consider them as "new" docs and think it terms of structure, completeness, redundancy. It doesn't make the task that much easier, but it should make it tractable. |
|
closes #353 |
|
@rahulporuri I think it makes sense to push this through now and go forward making improvements in smaller separate PRs. Given what you had said this morning I am going to go ahead and merge |
|
@aaronayres35 @rahulporuri Thank you for pushing this through! 🙇♂️ Aaron: FYI, for the magic "Closes #XX" to work, it must be in the PR description. It can't be only in a comment. |
Ah makes sense. Thats good to know, thank you! |
No description provided.