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.

Sign up for GitHub

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

Jump to bottom

Flatten docs #281

Closed
khaeru opened this issue Mar 17, 2020 · 0 comments · Fixed by #329
Closed

Flatten docs #281

khaeru opened this issue Mar 17, 2020 · 0 comments · Fixed by #329
Labels
docs Documentation, tutorials, etc. enh New features & functionality
Milestone
3.0

Comments

@khaeru
Copy link
Member

khaeru commented Mar 17, 2020

Both @danielhuppmann and @behnam-zakeri recently asked where to locate the "Configuration" section of the docs. IMO, this is a good indication that they're not in an obvious location.

Currently the hierarchy is:

  • Main page
    • Scientific programming API reference
      • Python
        • Configuration

We should flatten this and move the "Configuration" section to its own page; at the same level as and following "Installation," since it is usually the next step.
@khaeru khaeru added enh New features & functionality docs Documentation, tutorials, etc. labels Mar 17, 2020
@khaeru khaeru added this to the 3.0 milestone Mar 17, 2020
@khaeru khaeru mentioned this issue Apr 27, 2020
Merged
3 tasks
@khaeru khaeru mentioned this issue May 27, 2020
Merged
3 tasks
@khaeru khaeru linked a pull request May 27, 2020 that will close this issue
Clean up prior to 3.0.0 #329
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation, tutorials, etc. enh New features & functionality
Projects
None yet
Milestone
3.0
Development

Successfully merging a pull request may close this issue.

Clean up prior to 3.0.0 iiasa/ixmp
1 participant
@khaeru