sabledocs
Simple static documentation generator for Protobuf and gRPC contracts.
파일 탐색기
최종 버전 다운로드 (.zip)- config.yml
- Dockerfile
- Dockerfile
- Dockerfile
- custom_comments_parser.py
- descriptor.pb
- google-cloud-sdk.pb
- intro.md
- sable-test.pb
- sable-test.proto
- sabledocs.toml
- mystyles.scss
- fontawesome.js
- lunr.js
- mystyles.css
- theme.js
- base.html
- enum.html
- index.html
- message.html
- package.html
- search.html
- service.html
- type_name.html
- __init__.py
- __main__.py
- comments_parser.py
- lunr_search.py
- proto_descriptor_parser.py
- proto_model.py
- requirements.txt
- sable_config.py
- test_proto_descriptor_parser.py
- .gitattributes
- .gitignore
- CHANGELOG.md
- generate_sample_docs.sh
- LICENSE
- MANIFEST.in
- mystyles.css
- package-lock.json
- package.json
- pyproject.toml
- README.md
- setup.cfg
# 설치 가이드
1. 코드 내려받기
git clone https://github.com/markvincze/sabledocs
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd sabledocs
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. 공식 설치 스크립트
쉬움 추천사전 준비물
- Python 3 pip 명령어를 쓰려면 Python이 필요합니다.
pip install sabledocs
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
3. Docker
쉬움사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
docker build -f docker/alpine/Dockerfile -t sabledocs .
Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.
docker run -p 8080:80 sabledocs
빌드된 이미지를 실제 컨테이너로 실행합니다.
터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.
4. Node.js
쉬움사전 준비물
npm run css-build; pip install ..; sabledocs; .\output\index.html
requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.
npm run css-build && pip install .. && sabledocs && .\output\index.html
requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.
명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
5. Python
쉬움사전 준비물
pip install sabledocs
PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.
python -m build
파이썬 스크립트(또는 모듈)를 실행합니다.
python -m twine upload --repository testpypi dist/*
파이썬 스크립트(또는 모듈)를 실행합니다.
pip install -e .
requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.
npm run css-build; pip install ..; sabledocs; .\output\index.html
requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.
에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
// repository documentation
Was this content helpful?
(0 ratings)