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

Add a NEST documentation style guide #1986

Merged
merged 73 commits into from
Jun 9, 2021
Merged

Add a NEST documentation style guide #1986

merged 73 commits into from
Jun 9, 2021

Commits on Oct 10, 2019

  1. add vale linter to master

    @jessica-mitchell
    jessica-mitchell committed Oct 10, 2019
    Configuration menu
    Copy the full SHA
    1fbb35a View commit details
    Browse the repository at this point in the history

Commits on Oct 11, 2019

  1. create styleguide for nest

    @jessica-mitchell
    jessica-mitchell committed Oct 11, 2019
    Configuration menu
    Copy the full SHA
    a1085fc View commit details
    Browse the repository at this point in the history

  2. minor improvements

    @jessica-mitchell
    jessica-mitchell committed Oct 11, 2019
    Configuration menu
    Copy the full SHA
    cb30a48 View commit details
    Browse the repository at this point in the history

  3. minor improvements

    @jessica-mitchell
    jessica-mitchell committed Oct 11, 2019
    Configuration menu
    Copy the full SHA
    474f1b2 View commit details
    Browse the repository at this point in the history

Commits on Nov 7, 2019

  1. tidy up guide

    @jessica-mitchell
    jessica-mitchell committed Nov 7, 2019
    Configuration menu
    Copy the full SHA
    8222a21 View commit details
    Browse the repository at this point in the history

Commits on Mar 3, 2021

  1. Merge remote-tracking branch 'origin' into nest_styleguide

    @jessica-mitchell
    jessica-mitchell committed Mar 3, 2021
    Configuration menu
    Copy the full SHA
    df5c430 View commit details
    Browse the repository at this point in the history

  2. update style guide

    @jessica-mitchell
    jessica-mitchell committed Mar 3, 2021
    Configuration menu
    Copy the full SHA
    3ce3443 View commit details
    Browse the repository at this point in the history

  3. a few more updates

    @jessica-mitchell
    jessica-mitchell committed Mar 3, 2021
    Configuration menu
    Copy the full SHA
    d2c0e3d View commit details
    Browse the repository at this point in the history

Commits on Mar 5, 2021

  1. remove additional files

    @jessica-mitchell
    jessica-mitchell committed Mar 5, 2021
    Configuration menu
    Copy the full SHA
    5e1cbad View commit details
    Browse the repository at this point in the history

Commits on Mar 9, 2021

  1. Move styleguide motivation to top

    @sarakonradi
    sarakonradi committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    7c3db40 View commit details
    Browse the repository at this point in the history

  2. Reword introduction

    @sarakonradi
    sarakonradi committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    566dc26 View commit details
    Browse the repository at this point in the history

  3. Add RST CheatSheet link

    @sarakonradi
    sarakonradi committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    4276a82 View commit details
    Browse the repository at this point in the history

  4. Shorten RST subheadings

    @sarakonradi
    sarakonradi committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    13e9263 View commit details
    Browse the repository at this point in the history

  5. Update RST sections

    @sarakonradi
    sarakonradi committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    ff6ba7d View commit details
    Browse the repository at this point in the history

  6. Update Pronouns section

    @sarakonradi
    sarakonradi committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    9d7fe9e View commit details
    Browse the repository at this point in the history

  7. Update dictionary link

    @sarakonradi
    sarakonradi committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    320db1b View commit details
    Browse the repository at this point in the history

  8. Add style guide link to workflow

    @sarakonradi
    sarakonradi committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    fdf03eb View commit details
    Browse the repository at this point in the history

  9. Link style guide in contribute page

    @sarakonradi
    sarakonradi committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    3b931dd View commit details
    Browse the repository at this point in the history

Commits on Mar 12, 2021

  1. Fix conflict in doc/userdoc/contribute/index.rst

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    838a201 View commit details
    Browse the repository at this point in the history

  2. update voice section

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    67b5359 View commit details
    Browse the repository at this point in the history

  3. Adjust underlines

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    9433c0d View commit details
    Browse the repository at this point in the history

  4. Update subheadings

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    c907402 View commit details
    Browse the repository at this point in the history

  5. remove vale files

    @jessica-mitchell
    jessica-mitchell committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    26fb5db View commit details
    Browse the repository at this point in the history

  6. Merge branch 'master' into nest_styleguide

    @jessica-mitchell
    jessica-mitchell committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    aad7c4a View commit details
    Browse the repository at this point in the history

  7. Update double back tick section

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    2283819 View commit details
    Browse the repository at this point in the history

  8. Fix typo

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    32fa9a4 View commit details
    Browse the repository at this point in the history

  9. Remove extra article

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    823dd1e View commit details
    Browse the repository at this point in the history

  10. Fix NumPy link

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    9891a27 View commit details
    Browse the repository at this point in the history

  11. Update headings section

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    d5924c7 View commit details
    Browse the repository at this point in the history

  12. Break lines

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    b4448cd View commit details
    Browse the repository at this point in the history

  13. Merge branch 'nest_styleguide' of github.com:jessica-mitchell/nest-si… 

    …mulator into nest_styleguide
    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    f79acac View commit details
    Browse the repository at this point in the history

  14. Minor cleanup

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    743980a View commit details
    Browse the repository at this point in the history

  15. Update reference

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    0c9eb1d View commit details
    Browse the repository at this point in the history

  16. Fix typo

    @sarakonradi
    sarakonradi committed Mar 12, 2021
    Configuration menu
    Copy the full SHA
    a0f230d View commit details
    Browse the repository at this point in the history

Commits on Mar 15, 2021

  1. Merge pull request #14 from sarakonradi/nest_styleguide 

    Update NEST documentation style guide
    @jessica-mitchell
    jessica-mitchell authored Mar 15, 2021
    Configuration menu
    Copy the full SHA
    2cbd0d5 View commit details
    Browse the repository at this point in the history

  2. few fixes to grammar, add note links to api and hover

    @jessica-mitchell
    jessica-mitchell committed Mar 15, 2021
    Configuration menu
    Copy the full SHA
    bc06ef8 View commit details
    Browse the repository at this point in the history

Commits on Mar 18, 2021

  1. add intersphinx, fix up hover tooltip

    @jessica-mitchell
    jessica-mitchell committed Mar 18, 2021
    Configuration menu
    Copy the full SHA
    14383b3 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'master' into nest_styleguide

    @jessica-mitchell
    jessica-mitchell committed Mar 18, 2021
    Configuration menu
    Copy the full SHA
    fdf797c View commit details
    Browse the repository at this point in the history

Commits on Apr 14, 2021

  1. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    4526d78 View commit details
    Browse the repository at this point in the history

  2. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    aaf2a95 View commit details
    Browse the repository at this point in the history

  3. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    1df19a0 View commit details
    Browse the repository at this point in the history

  4. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    6766482 View commit details
    Browse the repository at this point in the history

  5. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    38d7723 View commit details
    Browse the repository at this point in the history

  6. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    e5df80f View commit details
    Browse the repository at this point in the history

  7. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    15a646d View commit details
    Browse the repository at this point in the history

  8. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    5061907 View commit details
    Browse the repository at this point in the history

  9. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    3195f1f View commit details
    Browse the repository at this point in the history

  10. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Jochen Martin Eppler <[email protected]>
    @jessica-mitchell @jougs
    jessica-mitchell and jougs authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    6316c8e View commit details
    Browse the repository at this point in the history

  11. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    3ce0d00 View commit details
    Browse the repository at this point in the history

  12. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    be4470a View commit details
    Browse the repository at this point in the history

  13. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    a72b5a8 View commit details
    Browse the repository at this point in the history

  14. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    5902bfb View commit details
    Browse the repository at this point in the history

  15. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    f0e16ae View commit details
    Browse the repository at this point in the history

  16. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    08c4b33 View commit details
    Browse the repository at this point in the history

  17. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    5093760 View commit details
    Browse the repository at this point in the history

  18. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    1e059da View commit details
    Browse the repository at this point in the history

  19. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    c489add View commit details
    Browse the repository at this point in the history

  20. Update doc/userdoc/styleguide/styleguide.rst 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 14, 2021
    Configuration menu
    Copy the full SHA
    2529743 View commit details
    Browse the repository at this point in the history

Commits on Apr 15, 2021

  1. change dash to colon, change boldface to emphasis, rearrange text so … 

    …all math, code together, explain better roles directives, add notes about linking to functions, reorganize bibliography, added info about intersphinx, updated admonitions to a possibly reasonable list
    @jessica-mitchell
    jessica-mitchell committed Apr 15, 2021
    Configuration menu
    Copy the full SHA
    3eb440f View commit details
    Browse the repository at this point in the history

Commits on Apr 16, 2021

  1. move styleguide to contribute, update links and refs, update number f… 

    …ormat, lists, reword
    @jessica-mitchell
    jessica-mitchell committed Apr 16, 2021
    Configuration menu
    Copy the full SHA
    961786b View commit details
    Browse the repository at this point in the history

Commits on Apr 20, 2021

  1. add some links, fix typos and inconsistencies, add suggestions from r… 

    …eview, improve intersphinx text
    @jessica-mitchell
    jessica-mitchell committed Apr 20, 2021
    Configuration menu
    Copy the full SHA
    5d6a9e4 View commit details
    Browse the repository at this point in the history

Commits on Apr 22, 2021

  1. Apply suggestions from code review 

    Co-authored-by: Hans Ekkehard Plesser <[email protected]>
    @jessica-mitchell @heplesser
    jessica-mitchell and heplesser authored Apr 22, 2021
    Configuration menu
    Copy the full SHA
    3788521 View commit details
    Browse the repository at this point in the history

  2. fix up punctuation, move sections around and rename them, add a docum… 

    …ent to showcase links better, correct explanation about get and set, limit contents to 1 depth
    @jessica-mitchell
    jessica-mitchell committed Apr 22, 2021
    Configuration menu
    Copy the full SHA
    0233b6b View commit details
    Browse the repository at this point in the history

Commits on Apr 27, 2021

  1. apply suggestions from Anne Devismes, separate tmeplates and style gu… 

    …ide folders, apply suggestions from ovdc
    @jessica-mitchell
    jessica-mitchell committed Apr 27, 2021
    Configuration menu
    Copy the full SHA
    ae183e5 View commit details
    Browse the repository at this point in the history

Commits on May 7, 2021

  1. modify css - remove border and bg from fixed-width items, remove colo… 

    …ur from non-linked items
    @jessica-mitchell
    jessica-mitchell committed May 7, 2021
    Configuration menu
    Copy the full SHA
    eea6cff View commit details
    Browse the repository at this point in the history

Commits on May 9, 2021

  1. fix formula

    @jessica-mitchell
    jessica-mitchell committed May 9, 2021
    Configuration menu
    Copy the full SHA
    bc9735c View commit details
    Browse the repository at this point in the history

  2. add text based on meeting on styleguide, clear up numpy style differe… 

    …nces, emphasis and backticks
    @jessica-mitchell
    jessica-mitchell committed May 9, 2021
    Configuration menu
    Copy the full SHA
    796d86d View commit details
    Browse the repository at this point in the history

Commits on May 11, 2021

  1. update paths

    @jessica-mitchell
    jessica-mitchell committed May 11, 2021
    Configuration menu
    Copy the full SHA
    79fb759 View commit details
    Browse the repository at this point in the history

  2. apply changes suggested by Clinssen

    @jessica-mitchell
    jessica-mitchell committed May 11, 2021
    Configuration menu
    Copy the full SHA
    262bbc9 View commit details
    Browse the repository at this point in the history

  3. fix periods

    @jessica-mitchell
    jessica-mitchell committed May 11, 2021
    Configuration menu
    Copy the full SHA
    30c4c66 View commit details
    Browse the repository at this point in the history

Commits on Jun 7, 2021

  1. remove features not implemented yet

    @jessica-mitchell
    jessica-mitchell committed Jun 7, 2021
    Configuration menu
    Copy the full SHA
    9a13cd6 View commit details
    Browse the repository at this point in the history

Commits on Jun 8, 2021

  1. applying suggestions from review, remove link to intersphinx and hove… 

    …rxref
    @jessica-mitchell
    jessica-mitchell committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    f269def View commit details
    Browse the repository at this point in the history

Commits on Jun 9, 2021

  1. Apply style guide to style guide

    @jougs
    jougs authored Jun 9, 2021
    Configuration menu
    Copy the full SHA
    a56f34e View commit details
    Browse the repository at this point in the history