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

[docs] added possibility for collapsing sections #1594

Merged
merged 6 commits into from
Aug 23, 2018
Merged

[docs] added possibility for collapsing sections #1594

merged 6 commits into from
Aug 23, 2018

Conversation

StrikerRUS
Copy link
Collaborator

Refer to #1553 (comment) .

Due to the fact that the installation guide is getting bigger and bigger

  • added Contents at the top of the file;
  • added possibility to collapse sections with building non-regular versions (collapsed by default).

Unfortunately, I can't find the way to implement collapsing technique with less lines of code.
If I'm not mistaken, approximately year ago @henry0312 you were against JS code, so I want to know your opinion. Maybe just adding Contents is enough, I don't know...

It looks like:
collapsed:
image

uncollapsed:
image

If someone forgot how to build documentation locally: https://github.com/Microsoft/LightGBM/blob/collapse/docs/README.rst#build

I'm not sure that ^ and v is the best choice, I'm open for proposals from this list https://fontawesome.com/v4.7.0/icons/ .

@chivee
Copy link
Collaborator

chivee commented Aug 21, 2018

Nice and neat!

@chivee chivee merged commit 8ff1e94 into master Aug 23, 2018
@chivee chivee deleted the collapse branch August 23, 2018 02:07
@lock lock bot locked as resolved and limited conversation to collaborators Mar 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants