Change Details

We've been discussing whether to move the manual to sphinx. This is for two reasons: 1. The most important one is that the current manual is hard to translate. We are using the wonderful plugin that userbase uses, but while having an excellent interface, it cannot translate URLs, and thus not translate categories. Furthermore, we have trouble getting search to work with the non-latin script translations. 2. Offline copies. 3. We are still not sure what to do with the python API docs. Sphinx might be an answer to help with this. There's one major disadvantage to sphinx and that is that it is much more technical to use than mediawiki. It will need to have the docs stored in a git repository, while a building system builds it once in a while. We will need to write better contributor's guides for this reason as well as provide workflows so easy that a twelve year old can contribute. Finally, porting the wiki will take time, even if we use pandoc to translate to rst. Our previous porting from mediawiki to mediawiki took a month to make sure everything's clean. We do not have time right now. I want to delay this to after **at the least **the 4.0 release.

We've been discussing whether to move the manual to sphinx. This is for two reasons: 1. The most important one is that the current manual is hard to translate. We are using the wonderful plugin that userbase uses, but while having an excellent interface, it cannot translate URLs, and thus not translate categories. Furthermore, we have trouble getting search to work with the non-latin script translations. 2. Offline copies. 3. We are still not sure what to do with the python API docs. Sphinx might be an answer to help with this. There's one major disadvantage to sphinx and that is that it is much more technical to use than mediawiki. It will need to have the docs stored in a git repository, while a building system builds it once in a while. We have asked sysadmin and were told that the technical bits are feasible. However, community-wise, we will need to write better contributor's guides for this reason as well as provide workflows so clear and easy that a twelve year old can contribute. Finally, porting the wiki will take time, even if we use pandoc to translate to rst. Our previous porting from mediawiki to mediawiki took a month with 3 people to make sure everything was clean. We do not have time right now. I want to delay this to after **at the least **the 4.0 release. Please feel free to write down your thoughts.

We've been discussing whether to move the manual to sphinx. This is for two reasons: 1. The most important one is that the current manual is hard to translate. We are using the wonderful plugin that userbase uses, but while having an excellent interface, it cannot translate URLs, and thus not translate categories. Furthermore, we have trouble getting search to work with the non-latin script translations. 2. Offline copies. 3. We are still not sure what to do with the python API docs. Sphinx might be an answer to help with this. There's one major disadvantage to sphinx and that is that it is much more technical to use than mediawiki. It will need to have the docs stored in a git repository, while a building system builds it once in a while. We have asked sysadmin and were told that the technical bits are feasible. However, community-wise, we will need to write better contributor's guides for this reason as well as provide workflows so clear and easy that a twelve year old can contribute. Finally, porting the wiki will take time, even if we use pandoc to translate to rst. Our previous porting from mediawiki to mediawiki took a month with 3 people to make sure everything was clean. We do not have time right now. I want to delay this to after **at the least **the 4.0 release. Finally, porting the wiki will take time, even if we use pandoc to translate to rst. Our previous porting from mediawiki to mediawiki took a month to make sure everything's clean. We do not have time right now. I want to delay this to after **at the least **the 4.0 releasePlease feel free to write down your thoughts.