-
Notifications
You must be signed in to change notification settings - Fork 125
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
- #369
Comments
Hello, I have already done some experiments in this direction: please take a look at my experiments and reuse whatever might be useful ... regards, |
Henk-Jan Ebbers Bots Open Source EDI Translator: http://bots.sourceforge.net
|
I really like the MkDocs version... nice layout (would be better if the navigation bar sections collapsed in levels), theme looks nice, search works well. I agree we need to make a decision on "final" location of the official documentation, There have been several occasions recently I would have made updates... but where? Then all the wiki links within Bots GUI need to be updated; there are not many. |
The basic Github wiki allows easy editing as you browse, but how do you edit the MkDocs version? |
"Home" should go to introduction, not sidenavigation |
Thanks for the interest in my experiments. The github repo for the MkDocs version is at http://github.com/skilchen/bots_doc_b
you might try to modify my experimental version in this way ... if @eppye likes it, he would then have to take the files in my repo back and create his own documentation repository. unfortunately my MkDocs knowhow is minimal, so i don't know if it supports collapsible navigation bar sections. |
Hi, I also think that this read the docs manual is very nice. For me it's not a Kind regards, Klaas On Thu, Feb 18, 2016 at 2:04 PM, skilchen notifications@github.com wrote:
|
I think one big advantage of a wiki is the instant editing right there on the page. I don't know much about git workflow but sounds like it would just get in the way a bit. That would sway my preference back to the standard wiki. |
In the meantime i have merged the sphinx-docs branch from http://github.com/abhishek-ram/bots and made the html output produced by sphinx viewable at http://skilchen.github.io/bots there is an open pull request for this version of the documentation at http://github.com/eppye-bots/bots. @abhishek-ram tried to enhance the structure of the docs. please check if you like his version of the documentation. i agree with @BikeMikeAU regarding the advantage of the wiki version. the main advantages of the other two solutions sphinx and mkdocs are imho:
|
@skilchen and @BikeMikeAU we can still make the changes to documentation on the github UI. What we need to do is go to the appropriate .rst file in your clone and make the needed changes. Once change has been made open a PR so that it is updated in the master clone. Once the PR is approved and merged the read-the-docs site is automatically updated with the changes. |
|
@eppye-bots the version you like is the one produced by @abhishek-ram
Now whenever you push something to your main repository the documentation at readthedocs will automatically be rebuilt. If you prefer to host your documentation as gh-pages on github, then the "easiest" procedure would be somewhat like:
and finally go to next time you make some changes to your documentation, you only have to execute the following steps:
evidently hosting the documentation on readthedocs.org is much simpler... my fork of your work including the contribution by @abhishek-ram is now also hosted on readthedocs the mkdocs people have made these steps invisible with their highly useful command: btw. in my repo i changed @abhishek-ram's index.rst to start with the table of content. using this structure the readthedocs site produces a reasonably good pdf version of your documentation. |
|
Henk-Jan Ebbers Bots Open Source EDI Translator: http://bots.sourceforge.net
|
you can either revert your revert or rewrite the history using then you probably have to use --force to push the changes back to github: |
@skilchen: I 've sent you an invite to the github "bot-edi" organisation. |
@eppye,
I'd love to help get the wiki stood up and operational for documentation, would you prefer a pull request to use the GitHub version or something like a readthedocs setup?
If you're interested in the assistance, please let me know which you would prefer and I'll get started on migrating the exported Wiki into full useable state in the format of your choice.
Thanks & looking forward to working with you.
-Dan
The text was updated successfully, but these errors were encountered: