Commit graph

55 commits

Author SHA1 Message Date
fbf9b49248
feat: add git install and pull to pdoc workflow
Some checks failed
website / build (push) Failing after 20s
This update modifies the pdoc workflow by adding git to the list of installed dependencies and incorporating a step to perform a `git pull`. The inclusion of git ensures that the latest version of the codebase is always used for generating documentation, enhancing the accuracy and relevance of the output. The change acknowledges the critical role of version control in continuous integration environments and aims to reduce discrepancies between the documentation and the codebase.

By ensuring the documentation is always in sync with the latest code, this adjustment helps to prevent confusion and fosters better understanding and usage of the software by end users and contributors alike.
2024-04-25 08:59:44 +02:00
a0cc7a742b
feat: optimize pdoc workflow and deps installation
Some checks failed
website / build (push) Failing after 20s
Reworked the Python dependency installation step in the `.forgejo/workflows/pdoc.yml` workflow file to install from the current directory (`.`) instead of specifying packages directly. This adjustment ensures that local package dependencies are correctly resolved and installed, aligning with best practices for Python projects. Additionally, streamlined the documentation generation process by modifying the `pdoc` execution command to use the package's dot notation, improving clarity and consistency in how the `pdoc` tool is invoked for generating Markdown documentation.

This change enhances the maintainability of our documentation workflow and ensures that our environment mirrors production more closely, potentially reducing the occurrence of "works on my machine" issues.
2024-04-25 08:58:31 +02:00
4f3159b3fa
refactor(workflows): streamline Python dep installation
Some checks failed
website / build (push) Failing after 27s
Simplified the Python dependency installation process within the pdoc workflow by combining multiple pip install commands into a single instruction. This reduces the number of steps and makes the workflow more efficient. The update also includes the removal of unnecessary comments and unused dependency installation commands, making the YAML file cleaner and easier to understand. This change could potentially speed up the documentation generation process by reducing the overall runtime of the workflow.
2024-04-25 08:53:35 +02:00
d5777fac54
refactor: restructure project for pip packaging
Some checks failed
website / build (push) Failing after 30s
Restructured the entire project directory, making `plankapy` pip-installable, enhancing its modularity and maintainability. This involved moving and renaming Python source files and tests into a dedicated `src/plankapy` structure, introducing a `pyproject.toml` for modern packaging standards, and removing obsolete `setup.py` and `__init__.py` files. Updated CI/CD pipelines to accommodate the new structure, ensuring continued automation efficiency. Added a `test_config.py` for centralized test configuration, improving test reliability and ease of modification.

- Migrated project documentation and workflow under new `.forgejo` directory for consistency with Forgejo platform requirements.
- Enhanced Docker containerization in CI builds by specifying a node-based container, streamlining the environment setup process.
- Expanded `.gitignore` to include `venv/`, promoting local development best practices.
- Introduced a comprehensive README update, clarifying the project's forked nature and pip-installation goal, fostering better community understanding and contribution suitability.
2024-04-25 08:48:11 +02:00
hwelch-fle
5c5d03c309
Merge pull request #3 from mikebirdgeneau/patch-1
Some checks are pending
website / build (push) Waiting to run
website / deploy (push) Blocked by required conditions
MInor update in `remove` method of `Label`
2024-01-16 23:36:19 -05:00
Mike Birdgeneau
23729ff99d
Update plankapy.py 2024-01-15 13:33:55 -07:00
Mike Birdgeneau
a5b7d6d0c2
Update plankapy.py 2024-01-15 13:33:12 -07:00
Mike Birdgeneau
6d7c04159f
Update plankapy.py
Fix reference to label_id.
2024-01-15 13:28:55 -07:00
hwelch-fle
ef9b2dea1d
Update README.md 2023-05-24 16:05:02 -04:00
hwelch-fle
e4c5f447bb
Update README.md 2023-05-24 16:04:09 -04:00
hwelch-fle
d050967100
Update README.md 2023-05-24 16:03:19 -04:00
hwelch-fle
969cb31552 remove doc folder 2023-05-01 16:30:22 -04:00
hwelch-fle
970550e341 Bolded returns 2023-05-01 15:53:55 -04:00
hwelch-fle
490649e41e more comment changes 2023-05-01 15:52:53 -04:00
hwelch-fle
9be8e6cae1 add space to markdown comments 2023-05-01 15:50:41 -04:00
hwelch-fle
4eceb43d44 Merge branch 'master' of https://github.com/hwelch-fle/plankapy 2023-05-01 15:50:14 -04:00
hwelch-fle
7085efaf93
Update README.md 2023-05-01 15:50:44 -04:00
hwelch-fle
9a4b8bed46 change docstring syntax 2023-05-01 15:50:12 -04:00
hwelch-fle
5d4f31da26
Update pdoc.yml 2023-05-01 15:48:28 -04:00
hwelch-fle
a97b606664
Update pdoc.yml 2023-05-01 15:46:57 -04:00
hwelch-fle
bd6de248a6
Update pdoc.yml 2023-05-01 15:45:38 -04:00
hwelch-fle
b1d88f6b1c
Update pdoc.yml 2023-05-01 15:43:36 -04:00
hwelch-fle
c7181579e2
Update pdoc.yml 2023-05-01 15:42:28 -04:00
hwelch-fle
21b630c754
Update pdoc.yml 2023-05-01 15:39:48 -04:00
hwelch-fle
b75c2c8bb2
Update pdoc.yml 2023-05-01 15:32:29 -04:00
hwelch-fle
be34f17734
Update pdoc.yml 2023-05-01 15:31:09 -04:00
hwelch-fle
023d61d9b6
Update pdoc.yml 2023-05-01 15:29:57 -04:00
hwelch-fle
74da2aac31
Update pdoc.yml 2023-05-01 15:18:39 -04:00
hwelch-fle
738b50c0dc
Update pdoc.yml 2023-05-01 15:17:46 -04:00
hwelch-fle
faafdabd44
Update pdoc.yml 2023-05-01 15:15:38 -04:00
hwelch-fle
0609019442
Update pdoc.yml 2023-05-01 15:15:20 -04:00
hwelch-fle
9952f880a8
Update pdoc.yml 2023-05-01 15:13:53 -04:00
hwelch-fle
841068cf13
Update pdoc.yml 2023-05-01 15:12:04 -04:00
hwelch-fle
9c86a285c6
Update pdoc.yml 2023-05-01 15:06:11 -04:00
hwelch-fle
3fa5fe0f1d
Update pdoc.yml 2023-05-01 15:05:23 -04:00
hwelch-fle
9efbdf4f47
Update pdoc.yml 2023-05-01 15:03:32 -04:00
hwelch-fle
09a46adaa6
Update pdoc.yml 2023-05-01 15:01:47 -04:00
hwelch-fle
cb9ec62884
Update pdoc.yml 2023-05-01 14:59:19 -04:00
hwelch-fle
bcbf41df48 added docs directory 2023-05-01 14:56:39 -04:00
hwelch-fle
3bf1a0c6e7
Update pdoc.yml 2023-05-01 14:52:02 -04:00
hwelch-fle
d8b032ddd0
on dispatch 2023-05-01 14:50:15 -04:00
hwelch-fle
758417a19a Merge branch 'master' of https://github.com/hwelch-fle/plankapy 2023-05-01 14:45:21 -04:00
hwelch-fle
e6c243debb
Added Docs Link 2023-05-01 14:46:26 -04:00
hwelch-fle
c868740ecf added builder 2023-05-01 14:45:19 -04:00
hwelch-fle
c28ba5a665
Update and rename static.yml to pdoc.yml 2023-05-01 14:44:37 -04:00
hwelch-fle
c10413c5c4
pdoc
automated pdoc documentation
2023-05-01 14:42:16 -04:00
hwelch-fle
14fdaf8ec0 Updated boardMembership template 2023-03-28 09:42:57 -04:00
hwelch-fle
9e904400d8 updated gitignore 2023-03-27 17:13:20 -04:00
hwelch-fle
035f7fc8e6 gitignore 2023-03-27 17:12:14 -04:00
hwelch-fle
d54dc61fd0 Merge branch 'master' of https://github.com/hwelch-fle/plankapy 2023-03-26 23:33:39 -04:00