diff --git a/README.md b/README.md index e222061..4ddf023 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,14 @@ Can be used as GitHub template repository, see [GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template). -You will need to find and replace occurences of `mockup` with the name of your package. This still might +You will need to find and replace occurences of + +- `mockup` -> `your_package_name` +- `rasmussenlab-mockup` -> `your_package_name` +- `RasmussenLab` -> `GitHub_user_name` (or organization) +- `python_package` -> `your_package_name` + +with the name of your package and GitHub user name (or organization). This still might need further testing: ```bash diff --git a/docs/README.md b/docs/README.md index cbce8fe..326c534 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,7 +12,7 @@ Install the docs dependencies of the package (as speciefied in toml): ```bash # in main folder -pip install .[docs] +pip install ".[docs]" ``` ## Build docs using Sphinx command line tools @@ -28,4 +28,4 @@ Options: sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/mockup # build docs sphinx-build -n -W --keep-going -b html ./ ./_build/ -``` \ No newline at end of file +``` diff --git a/pyproject.toml b/pyproject.toml index d3ed587..8271b14 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,6 +17,8 @@ classifiers = [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ] +# # add dependencies here: +# dependencies = ["numpy", "pandas", "scipy", "matplotlib", "seaborn"] [project.urls] "Bug Tracker" = "https://github.com/RasmussenLab/python_package/issues"