Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Location of Companion Guides #325

Open
odrobnik opened this Issue Feb 26, 2013 · 2 comments

Comments

Projects
None yet
2 participants
Contributor

odrobnik commented Feb 26, 2013

What is the proper method of including an entire Documentation folder for companion guides but still having the files end up in docs?

At present it seems that if you use --include folder it will always create a folder under docs for that messing up the back link to index as reported in #324.

The problem seems to be that appledoc should not try to preserve the folder, but only subfolders of a project. Or have an option to force appledoc to flatten the hierarchy.

Owner

tomaz commented Feb 27, 2013

This was actually intended so (if I understand correctly), so that all companion files would be embedded inside a folder, not scattered among the rest of the files (potentially overwriting one of the generated ones). The whole documents thing should work as described here. Seems like output is generated that way, it's just links that are broken, as you describe on #324?

Contributor

odrobnik commented Feb 27, 2013

Yes, the linking breaks down. You cannot link to name from the index page and the back links on a companion page are wrong, incorrectly including the docs in the URL

Von meinem iPhone gesendet

Am Feb 27, 2013 um 8:01 AM schrieb tomaz notifications@github.com:

This was actually intended so (if I understand correctly), so that all companion files would be embedded inside a folder, not scattered among the rest of the files (potentially overwriting one of the generated ones). The whole documents thing should work as described here. Seems like output is generated that way, it's just links that are broken, as you describe on #324?


Reply to this email directly or view it on GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment