Recipe doc #40
Recipe doc #40
Conversation
There was a problem hiding this comment.
Hi Jirko,
good job on the documentation!
Firstly, when it comes to the content, I believe it has everything it needs to, and it is more or less understandable. However, I believe, to fully understand it, it needs to be backed up by examples, which could be a nice thing for somebody to focus on next.
Secondly, I found some things that could use some polishing, so check them out, when you have time, and I am happy to discuss any of them.
Again, great job!
doc/101.rst
Outdated
There was a problem hiding this comment.
This file will need to be updated in the future, as it consists of outdated elements. However, as it is not the subject of this PR, I will not jump into them.
There was a problem hiding this comment.
Yes, that's true. However, could you please be more specific about the outdated elements (do you mean XML elements, or elements in a broader meaning)? It might deserve to elaborate a bit and create a GH issue to cover this.
There was a problem hiding this comment.
Firstly, the problem was once again with the viewer I used, it complained about the .rst elements, however they work fine on the intended platform.
Secondly, I did not check the XML elements or the content of this file, it should definitely be done in the future and updated if needed :)
|
@You-never-know Dane, thank you again for all your input and suggestions to improve the recipe documentation. I have addressed all of your findings, hope it will be mostly OK now :). |
There was a problem hiding this comment.
Hi @jikortus, thank you for the update of the documentation. I am satisfied with the changes and I approve the documentation.
I am not sure whether the external variables support commits should be part of this PR. The changes look good to me, but I suggest a review by Honza as he has more knowledge about this functionality, if you want to keep it a part of this PR.
|
Thanks @You-never-know! Indeed the three commits shouldn't be included, I took care of that. |
|
@jikortus Great, I believe we can merge these changes, so that's everything from my side. We just need someone with write access to approve it as well. |
- document all existing elements and how to use them - some smallish fixes to existing documentation - add autosectionlabel extension to Sphinx configuration to enable better crossreferences. - add config file for readthedocs.io.
|
Review done and issues fixed; previous commits have been squashed - @jstodola, can you please merge the changes? |
Documentation for anabot recipes.