rackerlabs / docs-core-infra-user-guide

User documentation source for Rackspace Cloud Core Infrastructure Services User Guide
https://developer.rackspace.com/docs/user-guides/infrastructure/
6 stars 26 forks source link

Removed obsolete _toc.rst to avoid confusion. #389

Closed meker12 closed 9 years ago

meker12 commented 9 years ago

The _toc.rst file isn't being used anymore. We removed it from the API dev guides to avoid confusing people. Maybe you would like to do the same. Thx!

rose-coste commented 9 years ago

@ktbartholomew added _toc.rst to give us a left-side TOC. I understand this works differently for userguides than it does for devguides. I can't do a local deconst build to confirm that this userguide has good left-side navigation without _toc.rst. @ktbartholomew, can you confirm deleting _toc.rst would be a good thing?

ktbartholomew commented 9 years ago

DO NOT MERGE

Removing _toc.rst from this repo would break the left-side navigation. The way this repo is rendered and the way the dev guides are rendered are very different, because this is a multi-page book, whereas the dev guides are single-page.

rose-coste commented 9 years ago

Thanks, @ktbartholomew; that's what I wondered. Closing this.

meker12 commented 9 years ago

I was able to delete it from my local clone of the core infrastructure guide, and build with the local client, and the contents looks OK.

I didn't think it did anything because the conf.py file points to the index.rst as the master_doc. But maybe the deconst build uses the _toc.rst for something else.

The subject of whether to keep this file came up in a discussion about the developer guides, and someone wanted to know what that file was for. Because we no longer use it, we removed it from the repository.