Skip to content

Commit 626798e

Browse files
committed
Apply new project-defaults
1 parent 9944d6c commit 626798e

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed
File renamed without changes.

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ You are welcome to contribute code in order to fix a bug, to implement a new fea
3939

4040
### Development Instructions
4141

42-
To simplify the process of building this project from scratch, we provide build scripts that run all necessary steps (build, test, and release) within a containerized environment by using [Github Actions](https://github.com/features/actions) and [Act](https://github.com/nektos/act) to run all actions locally.
42+
To simplify the process of building this project from scratch, we provide build-scripts - based on [universal-build](https://github.com/ml-tooling/universal-build) - that run all necessary steps (build, test, and release) within a containerized environment by using [Github Actions](https://github.com/features/actions) and [Act](https://github.com/nektos/act) to run all actions locally.
43+
44+
> _Please refer to the [documentation of universal-build](https://github.com/ml-tooling/universal-build#automated-build-pipeline-ci) for instructions on how to execute the build-scripts directly on your machine instead of using the containerized approach documented below._
4345
4446
#### Requirements
4547

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ To generate Markdown-based API documentation for your Python project, simply exe
5252
lazydocs path/to/your/package
5353
```
5454

55-
The path can be either a python package (folder) or a specific script. You can also specify one or multiple module, classe or function imports:
55+
The path can be either a python package (folder) or a specific script. You can also specify one or multiple module-, class- or function-imports:
5656

5757
```bash
5858
lazydocs my_package.AwesomeClass
@@ -70,7 +70,7 @@ This project is maintained by [Benjamin Räthlein](https://twitter.com/raethlein
7070
| 🎁&nbsp; **Feature Requests** | <a href="https://github.com/ml-tooling/lazydocs/issues?q=is%3Aopen+is%3Aissue+label%3Afeature+sort%3Areactions-%2B1-desc" title="Open Feature Request"><img src="https://img.shields.io/github/issues/ml-tooling/lazydocs/feature.svg?label=feature"></a> |
7171
| 👩‍💻&nbsp; **Usage Questions** | <a href="https://stackoverflow.com/questions/tagged/ml-tooling" title="Open Question on Stackoverflow"><img src="https://img.shields.io/badge/stackoverflow-ml--tooling-orange.svg"></a> <a href="https://gitter.im/ml-tooling/lazydocs" title="Chat on Gitter"><img src="https://badges.gitter.im/ml-tooling/lazydocs.svg"></a> |
7272
| 🗯&nbsp; **General Discussion** | <a href="https://gitter.im/ml-tooling/lazydocs" title="Chat on Gitter"><img src="https://badges.gitter.im/ml-tooling/lazydocs.svg"></a> <a href="https://twitter.com/mltooling" title="ML Tooling on Twitter"><img src="https://img.shields.io/twitter/follow/mltooling.svg?style=social"></a>|
73-
|&nbsp; **Other Requests** | <a href="mailto:[email protected]" title="Email ML Tooling Team"><img src="https://img.shields.io/badge/email-ML Tooling-green?logo=mail.ru&style=flat-square&logoColor=white"></a> |
73+
|&nbsp; **Other Requests** | <a href="mailto:[email protected]" title="Email ML Tooling Team"><img src="https://img.shields.io/badge/email-ML Tooling-green?logo=mail.ru&logoColor=white"></a> |
7474

7575
## Features
7676

@@ -215,7 +215,7 @@ The full Python API documentation can be found [here](https://github.com/ml-tool
215215

216216
> _**Requirements**: [Docker](https://docs.docker.com/get-docker/) and [Act](https://github.com/nektos/act#installation) are required to be installed on your machine to execute the build process._
217217

218-
To simplify the process of building this project from scratch, we provide build-scripts that run all necessary steps (build, check, test, and release) within a containerized environment. To build and test your changes, execute the following command in the project root folder:
218+
To simplify the process of building this project from scratch, we provide build-scripts - based on [universal-build](https://github.com/ml-tooling/universal-build) - that run all necessary steps (build, check, test, and release) within a containerized environment. To build and test your changes, execute the following command in the project root folder:
219219

220220
```bash
221221
act -b -j build

0 commit comments

Comments
 (0)