You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Keep the documentation sync with pippo (a doc for each pippo version) #11
I have multiple versions of pippo and I wish a public documentation for each pippo version
For example I wish to start to write the documentation for next pippo version but I don't know if I must create a new branch (for each pippo version a new doc branch) or we must go with readthedocs that supports this feature and more (for example I like the search - I think that it can be very useful).
I prefer a simple solution (I am happy to see that readthedocs supports markdown).
For Fathom I'm using MkDocs with a readthedocs theme. It gives you static searching BUT it does NOT have that nifty versioning feature from the ReadTheDocs service.
I haven't used the ReadTheDocs service but it looks pretty good. I think I read that MkDocs can be directly imported into ReadTheDocs so it might be something to look into. Or we could just jump right into ReadTheDocs to get that versioning feature.
The alternative is we become very good at adding version information to documentation.
The alternative is we become very good at adding version information to documentation.
I do not intend to add version information to documentation. Maybe something like "Since 0.5.0 ...". The idea was to create a branch for each pippo version, to make public (on pippo.ro) only the documentation for the last version (maybe an archive for oldest) and if someone wants to read the documentation for an old version then she must build that version locally.
Activity
gitblit commentedon Jun 22, 2015
For Fathom I'm using MkDocs with a readthedocs theme. It gives you static searching BUT it does NOT have that nifty versioning feature from the ReadTheDocs service.
I haven't used the ReadTheDocs service but it looks pretty good. I think I read that MkDocs can be directly imported into ReadTheDocs so it might be something to look into. Or we could just jump right into ReadTheDocs to get that versioning feature.
The alternative is we become very good at adding version information to documentation.
decebals commentedon Jun 22, 2015
Just thinking about https://readthedocs.org because it's free for open source projects.
I do not intend to add version information to documentation. Maybe something like "Since 0.5.0 ...". The idea was to create a branch for each pippo version, to make public (on pippo.ro) only the documentation for the last version (maybe an archive for oldest) and if someone wants to read the documentation for an old version then she must build that version locally.