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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize docs v2 #2174

Merged
merged 24 commits into from May 8, 2021
Merged

Reorganize docs v2 #2174

merged 24 commits into from May 8, 2021

Commits on May 1, 2021

  1. Switch to MyST-Parser + doc config cleanup

    recommonmark is being deprecated in favour of MyST-Parser. This change
    is welcomed, especially since MyST-Parser has syntax extensions for the
    Commonmark standard. Effectively we get to use a language that's powerful
    and expressive like ReST, but get the simplicity of Markdown.
    
    The rest of this effort will be using some MyST features.
    
    This reorganization efforts aims to remove as much duplication as possible.
    The regeneration step once needed is gone, significantly simplifing our
    Sphinx documentation configuration.
    ichard26 committed May 1, 2021
    Copy the full SHA
    ec32515 View commit details
    Browse the repository at this point in the history
  2. Tell pipenv we replaced recommonmark for MyST-Parser

    Also update `docs/requirements.txt`
    ichard26 committed May 1, 2021
    Copy the full SHA
    a541e40 View commit details
    Browse the repository at this point in the history
  3. Copy the full SHA
    6a5a43f View commit details
    Browse the repository at this point in the history
  4. Switch prettier for mdformat (plus a few plugins)

    prettier doesn't support MyST's syntax extensions which are going to be
    used in this reorganization effort so we have to switch formatter.
    
    Unfortanately mdformat's style is different from prettier's so time to
    reformat the whole repo too.
    
    We're excluding .github/ISSUE_TEMPLATE because I have no idea whether
    its changes are safe, so let's play it safe.
    ichard26 committed May 1, 2021
    Copy the full SHA
    9e74f45 View commit details
    Browse the repository at this point in the history
  5. Fix the heading levels in CHANGES.md + a link

    MyST-Parser / sphinx's linkcheck complains otherwise.
    ichard26 committed May 1, 2021
    Copy the full SHA
    599e074 View commit details
    Browse the repository at this point in the history
  6. Move reference docs into a docs/contributing dir

    They're for contributors of Black anyway. Also added a note in the
    summary document warning about the lack of attention the reference has
    been dealing with.
    ichard26 committed May 1, 2021
    Copy the full SHA
    c3bd835 View commit details
    Browse the repository at this point in the history
  7. Rewrite and setup the new landing page + main TOC

    - add some more detail about Black's beta status
    - add licensing info
    - add external links in the main TOC for GitHub, PyPI, and IRC
    - prepare main TOC for new structure
    ichard26 committed May 1, 2021
    Copy the full SHA
    d63eef5 View commit details
    Browse the repository at this point in the history
  8. Break out AUTHORS into its own file

    Not only was the AUTHORS list quite long, this makes it easy to include
    it in the Sphinx docs with just a simple symlink.
    ichard26 committed May 1, 2021
    Copy the full SHA
    9f1f940 View commit details
    Browse the repository at this point in the history
  9. Add license to docs via a simple include

    Yes the document is orphaned but it is linked to in the landing page
    (docs/index.rst).
    ichard26 committed May 1, 2021
    Copy the full SHA
    e3d4843 View commit details
    Browse the repository at this point in the history
  10. Add "The Black Code Style" section

    This mostly was a restructuring commit, there has been a few updates but
    not many. The main goal was to split "current style" and "planned
    changes to the style that haven't happened yet" to avoid confusion.
    ichard26 committed May 1, 2021
    Copy the full SHA
    0bb048b View commit details
    Browse the repository at this point in the history
  11. Add "Getting Started" page

    This is basically a quick start + even more. This commit is certainly
    one of most creatively involved in this effort.
    ichard26 committed May 1, 2021
    Copy the full SHA
    a76beca View commit details
    Browse the repository at this point in the history
  12. Add "Usage and Configuration" section

    This commit was as much restructuring as new content. Instead of being
    in one giant file, usage and configuration documentation can expand
    without bloating a single file.
    ichard26 committed May 1, 2021
    Copy the full SHA
    37f8002 View commit details
    Browse the repository at this point in the history
  13. Add "Integrations" section

    Just a restructuring commit ...
    ichard26 committed May 1, 2021
    Copy the full SHA
    6f3a927 View commit details
    Browse the repository at this point in the history
  14. Add "Guides" section

    This is a promising area of documentation that could easily grow in the
    future, let's prepare for that!
    ichard26 committed May 1, 2021
    Copy the full SHA
    ebf31d5 View commit details
    Browse the repository at this point in the history
  15. Add "Contributing" section

    This is also another area that I expect to see significant growth in.
    Contributors to Black could definitely do with some more specific docs
    that clears up certain parts of our slightly confusing project (it's
    only confusing because we're getting big and old!).
    ichard26 committed May 1, 2021
    Copy the full SHA
    361f690 View commit details
    Browse the repository at this point in the history
  16. Copy the full SHA
    8454176 View commit details
    Browse the repository at this point in the history
  17. Copy the full SHA
    2c60e5a View commit details
    Browse the repository at this point in the history

Commits on May 7, 2021

  1. Address feedback + a lot of corrections and edits

    I know I said I wanted to do these after landing this but given there's
    going to be no time between this being merged and a release getting
    pushed, I want these changes to make it in.
    
    - drop the number flag for mdformat - to reduce diffs, see also:
      https://mdformat.readthedocs.io/en/stable/users/style.html#ordered-lists
    - the GH issue templates should be safe by mdformat, so get rid of the
      exclude
    - clarify our configuration position - i.e. stop claiming we don't have
      many options, instead say we want as little formatting knobs as
      possible
    - lots and lots of punctuation, spelling, and grammar corrections (thanks
      Jelle!)
    - use RTD as the source for the CHANGELOG too
    - visual style cleanups
    - add docs about our .gitignore behaviour
    - expand GHA Action docs
    - clarify we want the PR number in the CHANGELOG entry
    - claify Black's behaviour for with statements post Python 3.9
    - italicize a bunch of "Black"s
    
    Thank you goes to Jelle, Taneli (hukkinj1 on GH), Felix
    (felix-hilden on GH), and Wouter (wbolster on GH) for the feedback!
    ichard26 committed May 7, 2021
    Copy the full SHA
    d354346 View commit details
    Browse the repository at this point in the history
  2. Merge remote-tracking branch 'upstream/master' into reorganize-docs-v2

    merge conflicts suck, although these ones weren't too bad.
    ichard26 committed May 7, 2021
    Copy the full SHA
    e133283 View commit details
    Browse the repository at this point in the history

Commits on May 8, 2021

  1. Add changelog entry + fix merge conflict resolution error

    I consider this important enough to be worthy of a changelog entry :)
    ichard26 committed May 8, 2021
    Copy the full SHA
    dceb2f8 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    8b42cce View commit details
    Browse the repository at this point in the history
  3. Actually let's continue using prettier

    Prettier works fine for all of the default MyST syntax so let's not
    rock the boat as much. Dropping the mdformat commit was merge-conflict
    filled so here's additional commit instead.
    ichard26 committed May 8, 2021
    Copy the full SHA
    7252d1e View commit details
    Browse the repository at this point in the history
  4. Address Cooper's, Taneli's, and Jelle's feedback

    Lots of wording improvements by Cooper. Taneli suggested to disable the
    enabled by default MyST syntax not supported by Prettier and I agreed.
    And Jelle found one more spelling error!
    ichard26 committed May 8, 2021
    Copy the full SHA
    316dc5e View commit details
    Browse the repository at this point in the history
  5. More minor fixes

    ichard26 committed May 8, 2021
    Copy the full SHA
    7940073 View commit details
    Browse the repository at this point in the history