search

emmo-repo / EMMOntoPy

Library for representing and working with ontologies in Python
https://emmo-repo.github.io/EMMOntoPy
BSD 3-Clause "New" or "Revised" License
40 stars 9 forks source link

Update public documentation to new framework #234

Closed CasperWA closed 3 years ago

CasperWA commented 3 years ago

I've set up the new framework and documentation in the test-mike branch, updated it with the old documentation as well as a correct versioning for the current EMMOntoPy/EMMO-python package and EMMO PyPI version.

In order to "publish" it, it should be force pushed to the gh-pages branch, which will automagically publish the new documentation style.

I've tested the workflow for updating and publishing new versions locally, it seems stable to keep the old documentation and more. I will document this workflow both in the form of the CD as well as actual documentation.

@jesper-friis and @francescalb please let me know here whether you are okay to "publish" the new documentation framework. You can test it out first by doing the following:

/path/to/EMMO-python$ git fetch origin && git checkout master
/path/to/EMMO-python$ git pull
/path/to/EMMO-python$ pip install -U -e .[docs]
/path/to/EMMO-python$ mike serve -r origin -b test-mike
Starting server at http://localhost:8000/
Press Ctrl+C to quit.

And then go to http://localhost:8000.

To dos:

francescalb commented 3 years ago

I think it is almost fine to publish it, after we have changed the EMMO-acronym and fixed the sized of the contributing project logos. I would like the first page to look more or less correct at least...

CasperWA commented 3 years ago

I think it is almost fine to publish it, after we have changed the EMMO-acronym and fixed the sized of the contributing project logos. I would like the first page to look more or less correct at least...

Good idea. I've added these two points to the OP as "to do"s with references to their respective issues and PR(s).

CasperWA commented 3 years ago

The new documentation framework has now officially been put in place: https://emmo-repo.github.io/EMMO-python 🎉 🌟