diff --git a/Makefile b/Makefile index f60f79d6..665c4725 100644 --- a/Makefile +++ b/Makefile @@ -16,7 +16,6 @@ build: check-local-env @docker build \ -t $(IMAGE_NAME):latest \ . - ## up : Run application in dev mode (using docker-compose) up: @docker-compose -f docker-compose.yml -f .devcontainer/docker-compose.yml up -d; @@ -41,10 +40,12 @@ test: test-up ## docs : Generate docs docs: test-up @docker exec $(CONTAINER_NAME_APP) bash -c "pip install -e .[docs]" - @docker exec $(CONTAINER_NAME_APP) bash -c "python setup.py docs" + # build from setup.py is no longer supported + # https://github.com/sphinx-doc/sphinx/pull/11363 + @docker exec $(CONTAINER_NAME_APP) bash -c "sphinx-build docs docs/_build/html" @docker cp $(CONTAINER_NAME_APP):/$(IMAGE_NAME)/docs/_build/html/ html_docs @docker-compose down - + ## log : Start a log tail on the last docker-compose command log: @docker-compose logs -f --tail=100 diff --git a/README.md b/README.md index b5889a53..790ab2bc 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ # OpenCLSim -**Open** source **C**omplex **L**ogistics **Sim**ulation - Rule driven scheduling of cyclic activities for in-depth comparison of alternative operating strategies. For background please read our [WODCON 2022 paper](https://www.dredging.org/resources/ceda-publications-online/conference-proceedings/abstract/1126), also available at [ResearchGate](https://www.researchgate.net/publication/360852095_OpenCLSim_Discrete_Event_Dredging_Fleet_Simulation_to_Optimise_Project_Costs). +**Open** source **C**omplex **L**ogistics **Sim**ulation - Rule driven scheduling of cyclic activities for in-depth comparison of alternative operating strategies. For background please read our [WODCON 2022 paper](https://www.dredging.org/resources/ceda-publications-online/conference-proceedings/abstract/1126), also available at [ResearchGate](https://www.researchgate.net/publication/360852095_OpenCLSim_Discrete_Event_Dredging_Fleet_Simulation_to_Optimise_Project_Costs). And our [Terra et Aqua 2023 paper](https://www.iadc-dredging.com/article/simulating-for-sustainability-alternative-operating-strategies-for-energy-efficiency/), available at [ResearchGate](https://www.researchgate.net/publication/371782674_Simulating_for_Sustainability_Alternative_Operating_Strategies_for_Energy_Efficiency) as well. Documentation is found [here](https://openclsim.readthedocs.io). diff --git a/setup.cfg b/setup.cfg index a5e6d60c..ca32dd60 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,7 +10,7 @@ author_email = "m.vankoningsveld@tudelft.nl", summary = The OpenCLSim package aims to facilitate rule based planning of cyclic activities and in depth comparison of different system concepts. keywords = OpenCLSim license = MIT -home-page = https://github.com/TUDelft-CITG/openclsim +home_page = https://github.com/TUDelft-CITG/openclsim description-file = README.md long_description_content_type = text/markdown description_content_type = text/markdown @@ -27,7 +27,9 @@ package_dir = =src install_requires = + setuptools>=61 importlib-metadata; python_version<"3.8" + setuptools_scm[toml]>=5 pandas>=0.24.0 numpy networkx