Skip to content
New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding included documents in TOC and index page. #198

Closed
wants to merge 1 commit into from
Closed

Adding included documents in TOC and index page. #198

wants to merge 1 commit into from

Conversation

smorel
Copy link
Contributor

@smorel smorel commented Mar 6, 2012

Hi, from your latest stable 2.0.5 tag, I added the ability to display the included documents in the TOC nodes and on the Index page.
It has been made quickly so I think you should review it correctly ;)
I also set the repeatFirstParagraphForMemberDescription in settings to NO by default, I think it's not useful for you!

Thanks for your work it's awesome !

…Description in discussion disabled by default.
@tomaz
Copy link
Owner

tomaz commented Mar 7, 2012

Looked at code and seems fine. As far as I understand, this adds documents to Xcode TOC available for browsing (alongside classes, categories and protocols) and creates a list of documents on index.html - so effectively this closes #188?

Oh, you can use latest appledoc code from master branch safely - I always push only after it's stable. If I need to work on a larger issue requiring more time, I do it in separate branches and only merge once it's stable for publishing. Makes pulling requests simpler :)

@smorel
Copy link
Contributor Author

smorel commented Mar 7, 2012

Ok perfect. I've been shy about using use the master as we used the 2.0.5 version already in our development pipeline :)

What I did is exactly what you said. The thing is that it's a naive and simple way to add the --include documents to the TOC and index page. This could be great (as hierarchy does) to match the included sub directory hierarchy of documents in the TOC.
Apple often have a tree with several depth grouping their documents in their TOC.
In the code I gave you everything is flattened to one level !

That being said, I didn't even checked the issue 188 so I can't tell you now if this is related I will check that asap.

@tomaz
Copy link
Owner

tomaz commented Mar 7, 2012

Don't worry, we always must start with first step :) I'll merge your changes, however need to do it manually so I have to figure it out :)

@tomaz
Copy link
Owner

tomaz commented Mar 7, 2012

Ok, merged the changes to main branch. Had to do manual merging so hopefully didn't break something :) I left first paragraph repeatition on as this was default so far and could unexpectedly change behavior on the users behind their backs - you can disable it for you inside global or project settings, then you don't have to repeat on each cmd line.

Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants