From c99ac5e8be43650b1848c390260c512621680e6c Mon Sep 17 00:00:00 2001 From: Kevin Liu Date: Sun, 5 Jan 2025 14:20:26 -0800 Subject: [PATCH] update instructions --- mkdocs/README.md | 5 ++--- mkdocs/requirements.txt | 28 ---------------------------- 2 files changed, 2 insertions(+), 31 deletions(-) delete mode 100644 mkdocs/requirements.txt diff --git a/mkdocs/README.md b/mkdocs/README.md index e9e0462bee..3730cd77fc 100644 --- a/mkdocs/README.md +++ b/mkdocs/README.md @@ -22,7 +22,6 @@ The pyiceberg docs are stored in `docs/`. ## Running docs locally ```sh -pip3 install -r requirements.txt -mkdocs serve -open http://localhost:8000/ +make install +make docs ``` diff --git a/mkdocs/requirements.txt b/mkdocs/requirements.txt deleted file mode 100644 index f374b85bea..0000000000 --- a/mkdocs/requirements.txt +++ /dev/null @@ -1,28 +0,0 @@ -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -mkdocs==1.6.1 -griffe==1.5.4 -jinja2==3.1.5 -mkdocstrings==0.27.0 -mkdocstrings-python==1.13.0 -mkdocs-literate-nav==0.6.1 -mkdocs-autorefs==1.2.0 -mkdocs-gen-files==0.5.0 -mkdocs-material==9.5.49 -mkdocs-material-extensions==1.3.1 -mkdocs-section-index==0.3.9