Conversation
|
I think the workflow is not so great at the moment. I changed so the rst files are automatically generated from scratch to get all parts in the docs without having to remember to manually modify when you have refactored something. But then I also added the rst files into version control which I think means they are not generated from scratch unless you remember to first delete all of them, build the docs locally and commit any modified files... So maybe having them in version control is not a good solution. I think the ideal solution would be to always automatically generate it from scratch and not have anything where manual tweaking is required because people will likely forget to do that and the docs become out of sync with the code. At least until we have reached a more stable version where parts are not significantly refactored anymore. What do you think? If I understood it correctly the rst files before contained some manual parts to not include some classes? |
|
OK I see. No worries. I only concerns only few |
|
Do you think it might be possible to name those fields/classes with I also think generated things should be removed. I only did it because it seemed to be the recommendation when I looked at the different options. But I'm not convinced that it's a good recommendation. |
|
I'm working on it and I can say that |
|
I also had a lot of issues... There is also |
|
I finally stopped trying to use |
|
@TeresiaOlsson |

Update code snippet for Arrays.
@gubaidulinvadim , @TeresiaOlsson , @simoneliuzzo
It seems that I lost modifications I did previously regarding the big list of .rst files in api ?
Is this list automatically generated, in case it has nothing to do there or can we update it by hand ?