Skip to content

Keep the documentation sync with pippo (a doc for each pippo version) #11

Open

Description

@decebals

The problem:

  • 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).

What you say?

Activity

  1. gitblit commented on Jun 22, 2015

    @gitblit
    Collaborator

    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.

  2. decebals commented on Jun 22, 2015

    @decebals
    MemberAuthor

    Just thinking about https://readthedocs.org because it's free for open source projects.

    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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions