Urgency of updating Mercurial website and initiate https://mercurial-scm.readthedocs.io ?
Matt Harbison
matt_harbison at yahoo.com
Thu Jan 2 17:37:48 UTC 2025
> On Dec 28, 2024, at 4:38 PM, PIERRE AUGIER <pierre.augier at univ-grenoble-alpes.fr> wrote:
>
> I worked on a draft using Sphinx which can be seen here https://mercurial.pages.heptapod.net/hg-website/topic/default/with-sphinx/index.html
>
> I have a question about the documentation of commands provided by evolve, topic and hg-git. Is there a simple way to get the raw docstring from Python ?
Don’t feel obligated to do anything with this info, but the reference to sphinx made me remember that TortoiseHg generates at least some of its documentation with it. (I think at one point, that got uploaded to readthedocs.) With the implication that common 3rd party stuff would also be documented on the website, it probably makes sense to throw that into the mix too somehow, since that’s the primary package for Windows (and currently the only one until the setup.py stuff gets resolved and we can get pyoxidizer going again for a vanilla hg installer).
There’s also the TortoiseHg.org website that lives in a git repo on bitbucket. I don’t know how that’s made, other than how to add references to new releases. It would be nice to integrate that too, and get away from git and BB.
> Pierre
>
> ----- Mail original -----
>> De: "Pierre-Yves David" <pierre-yves.david at octobus.net>
>> À: "PIERRE AUGIER" <pierre.augier at univ-grenoble-alpes.fr>, "Mercurial Devel" <mercurial-devel at mercurial-scm.org>
>> Envoyé: Samedi 21 Décembre 2024 16:45:49
>> Objet: Re: Urgency of updating Mercurial website and initiate https://mercurial-scm.readthedocs.io ?
>
>>> On 12/20/24 15:47, PIERRE AUGIER wrote:
>>> ----- Mail original -----
>>>> De: "Pierre-Yves David"<pierre-yves.david at octobus.net>
>>>> À: "PIERRE AUGIER"<pierre.augier at univ-grenoble-alpes.fr>, "Mercurial
>>>> Devel"<mercurial-devel at mercurial-scm.org>
>>>> Envoyé: Vendredi 20 Décembre 2024 15:34:33
>>>> Objet: Re: Urgency of updating Mercurial website and
>>>> initiatehttps://mercurial-scm.readthedocs.io ?
>>>> Why do you need a new repository for that? I think we can reuse the
>>>> existing website repository for the new version of the repository.
>>> Because I was thinking that Mercurial maintainers want to
>>> keephttps://www.mercurial-scm.org/ and that I could propose something else
>>> hosted somewhere else.
>>>
>>> Ifhttps://www.mercurial-scm.org can be static (I think it can), I can also
>>> propose something to replace it. However, I have to admit that I don't know
>>> anything about web things. I just know how to produce documentation websites
>>> based on Sphinx, myst and Jupyter. It would make sense to use such tools
>>> because there is a lot of content in Mercurial source in rst and Sphinx knows
>>> how to render that. For a project with not so much man power, it could make
>>> sense to go in this direction.
>>
>>
>> A good option for smaller iterative steps might be to start with this
>> documentation focused "section" and link to it from the main site. Then
>> update the rest of the main site. It would allow you to focus on what
>> you are familiar with for now.
>>
>> As far as I understand, Raphaël is currently the one with most interest
>> and knowledge about website, so I'll let him chime in when he is back
>> from vacation.
>>
>>
>>> I could reusehttps://foss.heptapod.net/mercurial/hg-website but there would be
>>> first a big commit to remove everything :-) So it might make sense to start in
>>> a new repo. I could also use a new name branch
>>> inhttps://foss.heptapod.net/mercurial/hg-website. What do you think?
>>
>> We can start in a topic there, and decide if we want it to be named
>> branch while it settle later.
>>
>> --
>> Pierre-Yves David
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel at lists.mercurial-scm.org
> https://lists.mercurial-scm.org/mailman/listinfo/mercurial-devel
More information about the Mercurial-devel
mailing list