Skip to content

Commit d123e3c

Browse files
committed
Remove API documentation generation from Makefile and update README with new API documentation link
1 parent f866e41 commit d123e3c

File tree

3 files changed

+3
-334
lines changed

3 files changed

+3
-334
lines changed

Makefile

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,4 @@ check-libs:
5555

5656
.PHONY: list-lib-versions
5757
list-lib-versions:
58-
go run ./cmd/download-libs -list
59-
60-
.PHONY: docs
61-
docs:
62-
@echo "📚 Generating API documentation..."
63-
@mkdir -p docs
64-
go doc -all > docs/API.md
65-
66-
.PHONY: docs-clean
67-
docs-clean:
68-
@echo "🧹 Cleaning generated documentation..."
69-
@rm -f docs/API.md
58+
go run ./cmd/download-libs -list

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![Go Report Card](https://goreportcard.com/badge/github.com/rticommunity/rticonnextdds-connector-go)](https://goreportcard.com/report/github.com/rticommunity/rticonnextdds-connector-go)
55
[![Build and Test](https://github.com/rticommunity/rticonnextdds-connector-go/actions/workflows/build.yml/badge.svg)](https://github.com/rticommunity/rticonnextdds-connector-go/actions/workflows/build.yml)
66
[![Go Version](https://img.shields.io/github/go-mod/go-version/rticommunity/rticonnextdds-connector-go)](https://github.com/rticommunity/rticonnextdds-connector-go/blob/master/go.mod)
7+
[![API Documentation](https://img.shields.io/badge/API-Documentation-blue)](https://godocs.io/github.com/rticommunity/rticonnextdds-connector-go)
78

89
> A lightweight, easy-to-use Go binding for RTI Connext DDS that enables rapid development of distributed applications.
910
@@ -312,7 +313,7 @@ The native code was originally designed for single-threaded environments (RTI Pr
312313

313314
## Documentation
314315

315-
-**[API Reference](docs/API.md)** - Complete Go API documentation
316+
-**[API Reference](https://godocs.io/github.com/rticommunity/rticonnextdds-connector-go)** - Complete Go API documentation
316317
- 📖 **[Examples](examples/README.md)** - Comprehensive examples and tutorials
317318
- 🧪 **[Testing Guide](TESTING.md)** - Development and testing guidelines
318319
- 📚 **[Library Management](docs/LIBRARY_MANAGEMENT.md)** - Managing RTI Connector libraries

docs/API.md

Lines changed: 0 additions & 321 deletions
This file was deleted.

0 commit comments

Comments
 (0)