Changed documentation files according some conventions #371
Conversation
| - [Frequently Asked Questions](frequently-asked-questions.md "Frequently Asked Questions") | ||
| - [Analog recording with multimeter](analog-recording-with-multimeter.md "Analog recording with multimeter") | ||
| - [Connection Management](connection-management.md "Connection Management") | ||
| - [Topological Connections](http://www.nest-simulator.org/wp-content/uploads/2015/04/Topology_UserManual.pdf "Topological Connections") |
There was a problem hiding this comment.
@heplesser: shouldn't we convert the topology manual to an IPython notebook or a plain markdown document at one point? I think the days of PDFs for documentation are over ;-) Can you please note this somewhere?
|
Many thanks for this. Can you please check why it does not apply cleanly and look at my comments? |
|
One more thing: can you please add a |
index.md - changing some minor things
|
|
||
| After NEST is installed and configured properly, you can start to build your | ||
| model. | ||
|
|
||
| ### Examples | ||
|
|
||
| A good starting point to learn more about modeling in NEST are the | ||
| [example networks](more-example-networks.md "Example networks") | ||
| that come together with NEST. | ||
| example networks that come together with NEST. |
There was a problem hiding this comment.
Sorry it is NOT working right now.
|
|
||
| A minimal example for the exchange of spikes between two independent instances | ||
| of NEST is given in the example `examples/nest/music/minimalmusicsetup.music`. | ||
| It uses one [SLI script](../an_introduction_to_sli/index.html "An Introduction | ||
| It uses one [SLI script](an-introduction-to-sli.md "An Introduction |
There was a problem hiding this comment.
Sorry, could not be found by my regular expression, because there was a linebreak.
|
@steffengraber Could you pull the newest changes from master, so that Travis can properly check the one modified code file? |
|
@heplesser |
| @@ -192,7 +184,7 @@ the help pages. The browser is set as an option of `helpdesk`. Please see the | |||
| file `~/.nestrc` for an example setting `firefox` as browser. Please note that | |||
| the command `helpdesk` does not work if you have compiled NEST with MPI support, | |||
| but you have to enter the address of the helpdesk | |||
| (`file://$PREFIX/share/doc/nest/index.html`) manually into the browser. | |||
| (`file://$PREFIX/share/doc/nest.md`) manually into the browser. | |||
There was a problem hiding this comment.
I think this should stay. The browser won't understand markdown.
There was a problem hiding this comment.
Ah, ok, you're absolutely correct.
|
👍 once my comments are addressed. Many thanks for the nice work! |
|
Done. |
|
Very nice. I'm merging without second review, as these changes concern only documentation. Many thanks for this contribution! |
Changed the documentation files according these conventions: