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

Developer documentation #259

Merged
merged 5 commits into from
Sep 24, 2024
Merged

Developer documentation #259

merged 5 commits into from
Sep 24, 2024

Conversation

jnikula
Copy link
Owner

@jnikula jnikula commented Sep 23, 2024

Start a place under doc/ to gather developer documentation. Add contributing guide and test readme for starters.

Apparently the defaults for page and sidebar widths are 940 and 220 px,
respectively. Make them slightly wider to allow for more content in the
vertical space, as well as longer entries in the navigation bar without
word wrapping. I'm not entirely happy that they're defined in pixels,
but not going to start fighting the theme.
Just a placeholder for starters. Will start gathering contributor
guideline, testing, etc. here, but also allows us to plug in the code
documentation from Python as needed.
Copy link
Collaborator

@BrunoMSantos BrunoMSantos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm ;)

}
},
'sidebar_width': '280px',
'page_width': '1000px',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are hidpi screens handled automatically through scaling? I think not, but bear in mind I know very little of CSS.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not my strong suit either, and I can only justify this because the original Alabaster stylesheet uses px.

@jnikula jnikula merged commit 706bb45 into master Sep 24, 2024
6 checks passed
@jnikula jnikula deleted the developer-documentation branch September 24, 2024 18:35
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.

2 participants