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

Add a NEST documentation style guide #1986

Merged
merged 73 commits into from Jun 9, 2021
Merged
Show file tree
Hide file tree
Changes from 64 commits
Commits
Show all changes
73 commits
Select commit Hold shift + click to select a range
1fbb35a
add vale linter to master
jessica-mitchell Oct 10, 2019
a1085fc
create styleguide for nest
jessica-mitchell Oct 11, 2019
cb30a48
minor improvements
jessica-mitchell Oct 11, 2019
474f1b2
minor improvements
jessica-mitchell Oct 11, 2019
8222a21
tidy up guide
jessica-mitchell Nov 7, 2019
df5c430
Merge remote-tracking branch 'origin' into nest_styleguide
jessica-mitchell Mar 3, 2021
3ce3443
update style guide
jessica-mitchell Mar 3, 2021
d2c0e3d
a few more updates
jessica-mitchell Mar 3, 2021
5e1cbad
remove additional files
jessica-mitchell Mar 5, 2021
7c3db40
Move styleguide motivation to top
sarakonradi Mar 9, 2021
566dc26
Reword introduction
sarakonradi Mar 9, 2021
4276a82
Add RST CheatSheet link
sarakonradi Mar 9, 2021
13e9263
Shorten RST subheadings
sarakonradi Mar 9, 2021
ff6ba7d
Update RST sections
sarakonradi Mar 9, 2021
9d7fe9e
Update Pronouns section
sarakonradi Mar 9, 2021
320db1b
Update dictionary link
sarakonradi Mar 9, 2021
fdf03eb
Add style guide link to workflow
sarakonradi Mar 9, 2021
3b931dd
Link style guide in contribute page
sarakonradi Mar 9, 2021
838a201
Fix conflict in doc/userdoc/contribute/index.rst
sarakonradi Mar 12, 2021
67b5359
update voice section
sarakonradi Mar 12, 2021
9433c0d
Adjust underlines
sarakonradi Mar 12, 2021
c907402
Update subheadings
sarakonradi Mar 12, 2021
26fb5db
remove vale files
jessica-mitchell Mar 12, 2021
aad7c4a
Merge branch 'master' into nest_styleguide
jessica-mitchell Mar 12, 2021
2283819
Update double back tick section
sarakonradi Mar 12, 2021
32fa9a4
Fix typo
sarakonradi Mar 12, 2021
823dd1e
Remove extra article
sarakonradi Mar 12, 2021
9891a27
Fix NumPy link
sarakonradi Mar 12, 2021
d5924c7
Update headings section
sarakonradi Mar 12, 2021
b4448cd
Break lines
sarakonradi Mar 12, 2021
f79acac
Merge branch 'nest_styleguide' of github.com:jessica-mitchell/nest-si…
sarakonradi Mar 12, 2021
743980a
Minor cleanup
sarakonradi Mar 12, 2021
0c9eb1d
Update reference
sarakonradi Mar 12, 2021
a0f230d
Fix typo
sarakonradi Mar 12, 2021
2cbd0d5
Merge pull request #14 from sarakonradi/nest_styleguide
jessica-mitchell Mar 15, 2021
bc06ef8
few fixes to grammar, add note links to api and hover
jessica-mitchell Mar 15, 2021
14383b3
add intersphinx, fix up hover tooltip
jessica-mitchell Mar 18, 2021
fdf797c
Merge branch 'master' into nest_styleguide
jessica-mitchell Mar 18, 2021
4526d78
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
aaf2a95
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
1df19a0
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
6766482
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
38d7723
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
e5df80f
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
15a646d
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
5061907
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
3195f1f
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
6316c8e
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
3ce0d00
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
be4470a
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
a72b5a8
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
5902bfb
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
f0e16ae
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
08c4b33
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
5093760
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
1e059da
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
c489add
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
2529743
Update doc/userdoc/styleguide/styleguide.rst
jessica-mitchell Apr 14, 2021
3eb440f
change dash to colon, change boldface to emphasis, rearrange text so …
jessica-mitchell Apr 15, 2021
961786b
move styleguide to contribute, update links and refs, update number f…
jessica-mitchell Apr 16, 2021
5d6a9e4
add some links, fix typos and inconsistencies, add suggestions from r…
jessica-mitchell Apr 20, 2021
3788521
Apply suggestions from code review
jessica-mitchell Apr 22, 2021
0233b6b
fix up punctuation, move sections around and rename them, add a docum…
jessica-mitchell Apr 22, 2021
ae183e5
apply suggestions from Anne Devismes, separate tmeplates and style gu…
jessica-mitchell Apr 27, 2021
eea6cff
modify css - remove border and bg from fixed-width items, remove colo…
jessica-mitchell May 7, 2021
bc9735c
fix formula
jessica-mitchell May 9, 2021
796d86d
add text based on meeting on styleguide, clear up numpy style differe…
jessica-mitchell May 9, 2021
79fb759
update paths
jessica-mitchell May 11, 2021
262bbc9
apply changes suggested by Clinssen
jessica-mitchell May 11, 2021
30c4c66
fix periods
jessica-mitchell May 11, 2021
9a13cd6
remove features not implemented yet
jessica-mitchell Jun 7, 2021
f269def
applying suggestions from review, remove link to intersphinx and hove…
jessica-mitchell Jun 8, 2021
a56f34e
Apply style guide to style guide
jougs Jun 9, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/userdoc/contribute/index.rst
Expand Up @@ -9,7 +9,8 @@ Please familiarize yourself with our:

* :doc:`NEST Git workflow <development_workflow>`
* :doc:`C++ coding style guidelines <coding_guidelines_cpp>`
* :doc:`Developing NEST with IDEs <nest_with_ides>`
* :doc:`Documentation style guide <templates_styleguides/styleguide>`
* :doc:`Developing NEST with IDEs guide <nest_with_ides>`

In order to make sure that the NEST Initiative can manage the NEST code base in the long term,
you need to send us a completed and signed
Expand All @@ -24,6 +25,8 @@ If you find an error in the code or documentaton or want to suggest a feature, s

Make sure to check that your issue has not already been reported there before creating a new one.

.. _edit_nest:

Change code or documentation
----------------------------

Expand Down
18 changes: 18 additions & 0 deletions doc/userdoc/contribute/styleguide/sample_doc.rst
@@ -0,0 +1,18 @@
Main title of document
======================


.. _sec_my-ref-label:

Section to cross-reference
--------------------------

Some content in this section.



.. _eq_my-arbitrary-place-label:

.. math::

e = mc^2
jessica-mitchell marked this conversation as resolved.
Show resolved Hide resolved