search

Molara-Lab / Molara

Molara is a Python package for the visualization of chemical structures such as molecules or crystals. It provides a graphical user interface for importing structures from output files of popular computational chemistry software as well as for creating custom structures.
GNU General Public License v3.0
11 stars 0 forks source link

readthedocs.org documentation #298

Closed adrianusler closed 2 months ago

adrianusler commented 4 months ago

Should we also create a project documentation on readthedocs.org? I think that this should be rather straightforward

flrnslbch commented 4 months ago

I have already setup a github pages documentation. It will look exactly like on readthedocs only the url will be molaralab.github.io/molara/ See PR #288

adrianusler commented 4 months ago

I know that we are getting the Sphinx documentation @flrnslbch. The question was if we do readthedocs.org on top.

The reason why I ask is this: readthedocs is a well-known "brand" in which people trust. When I start working with a package, it is the first thing that I look out for on Google. I think that it would also increase visibility.

ab5424 commented 4 months ago

@adrianusler What do we need readthedocs for that the shpinx doc on gh pages can't do? I don't really understand.

adrianusler commented 4 months ago

It's not about what it can do, but just about the name. Like I said, readthedocs is an established brand, so to say

ab5424 commented 4 months ago

@adrianusler I'm fine with it then, but I personally never though about that.

adrianusler commented 2 months ago

https://molara.readthedocs.io/en/latest/