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

Convert documentation tables to 'data::' records. Fixes #2037 #2038

Merged
merged 1 commit into from Nov 18, 2016

Conversation

Projects
None yet
3 participants
@omiday
Copy link
Contributor

omiday commented Oct 24, 2016

Converted all tables to 'data::' records and restructured the page based on IRC
feedback.

@justinmayer

This comment has been minimized.

Copy link
Member

justinmayer commented Nov 2, 2016

Many thanks for all your work on this, @omiday.

Would any @getpelican/reviewers care to submit a review on this pull request? Some help would be greatly appreciated. (^_^)

@justinmayer justinmayer changed the title Fixes #2037 Convert documentation tables to 'data::' records. Fixes #2037 Nov 14, 2016

@justinmayer

This comment has been minimized.

Copy link
Member

justinmayer commented Nov 14, 2016

Following up again... Any reviews from @getpelican/reviewers?

@iKevinY
Copy link
Member

iKevinY left a comment

I've always found RST's table syntax to be rather difficult to maintain, so I'm a big fan of this change! One downside is that GitHub's RST rendering doesn't seem to pick up the .. data:: records, but the Sphinx output looks great, and that's what really matters.

Once the merge conflicts have been resolved and the commits have been squashed, this should be good to merge!

@omiday omiday force-pushed the omiday:gh2037 branch from b25d717 to 4a6adb6 Nov 15, 2016

@justinmayer
Copy link
Member

justinmayer left a comment

Other than ensuring this PR has been rebased on current master — including the refactored MARKDOWN setting from a07c0e6 — this looks good to me.

``['.#*']`` will ignore emacs lock files, and ``['__pycache__']`` would
ignore Python 3's bytecode caches.

.. data:: MD_EXTENSIONS = {...}

This comment has been minimized.

@justinmayer

justinmayer Nov 15, 2016

Member

@omiday: Did you rebase on current master? I only ask because I believe this setting — MD_EXTENSIONS — was recently replaced by the MARKDOWN setting via: a07c0e6#diff-f47f8ca652dac550c8bc9d449ca0d253L117

This comment has been minimized.

@omiday

omiday Nov 17, 2016

Author Contributor

@justinmayer Oh my, what a mess I made :( I should have checked what/whether changes were introduced to the file I worked on (settings.rst) since Oct-23. I think my Git-fu has greatly improved while fixing this up so please accept my apologies and review the new PR.

Fix #2037. Major overhaul of settings page.
Convert all tables to 'data::' directives.

Replace inline literals with code blocks for better readability.

Per suggestion from Avaris on IRC:
- Section rename: "Path metadata" to "Metadata" and move over AUTHOR and
  all *_METADATA options.
- Merge "Date format and locale" and "Timezone" into a new section "Time
  and Date" and move over TIMEZONE, DEFAULT_DATE, DATE_FORMATS,
  DEFAULT_DATE_FORMAT.
- Move RELATIVE_URL under 'URL settings'. Here, convert URL settings
  example from a 4-bullet inline literal to a single code block for
  better readability in both source and output.
- Move *_TEMPLATE options under "Templates".

Cosmetic and wording updates to accommodate the above changes and
provide a consistent layout.

@omiday omiday force-pushed the omiday:gh2037 branch from 4a6adb6 to f30f4fe Nov 17, 2016

@justinmayer

This comment has been minimized.

Copy link
Member

justinmayer commented Nov 18, 2016

Many thanks to @omiday for the excellent contribution and to @iKevinY for reviewing! (^_^)

@justinmayer justinmayer merged commit c413bcd into getpelican:master Nov 18, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@omiday omiday deleted the omiday:gh2037 branch Mar 2, 2017

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