Comments (4)
I have the same issue with Mac.
from protoc-gen-doc.
@pcimring @ismailseyfi The trick is to mount your files to a place inside the docker container you're running using the -v
flag. So, assuming I'm in a directory with some file.proto
:
❯$ ls
file.proto
I'd run this:
docker run --rm -v ./docs:/out -v ./:/protos pseudomuto/protoc-gen-doc
... to generate docs in the ./docs subdirectory, like this:
❯$ tree
.
├── doc
│ ├── index.html
└── file.proto
Hope it helps
from protoc-gen-doc.
@pcimring @ismailseyfi The trick is to mount your files to a place inside the docker container you're running using the
-v
flag. So, assuming I'm in a directory with somefile.proto
:❯$ ls file.proto
I'd run this:
docker run --rm -v ./docs:/out -v ./:/protos pseudomuto/protoc-gen-doc... to generate docs in the ./docs subdirectory, like this:
❯$ tree . ├── doc │ ├── index.html └── file.proto
Hope it helps
If my .proto file is not in the same directory (because our project’s proto file directory corresponds to the package), and there is an uncertain hierarchical directory structure, how should I modify this command?
from protoc-gen-doc.
@pcimring @ismailseyfi any updates about this issue?
from protoc-gen-doc.
Related Issues (20)
- All protos in one folder - "-I" doesnt seem to work - generation fails due to import fails
- Add support for proto3's optional fields added in protoc 3.15
- Proposal: support code samples for messages and methods HOT 2
- Document how to expose custom annotations HOT 1
- 如何自定义中文提示
- Deprecated message doesn't show in doc HOT 1
- Automatically generate documentation for imports HOT 2
- Docker image with arm support HOT 1
- Custom Template Path in --doc_opt doesn't work with an absolute path
- Not including java_outer_classname
- is there any guidance to writing extensions for protoc-gen-doc?
- oneof support HOT 1
- Cannot set the template filename when using the buf remote plugin HOT 4
- How to write option to a generated file?
- How to add comments to generate the `lable` HOT 1
- JSON output loses field identification information
- Markdown: Remove multiple blanks
- File level documentation is not generated HOT 1
- Ambiguous import error
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from protoc-gen-doc.