Skip to content

Commit

Permalink
fix subdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
woojoong88 committed Nov 19, 2024
1 parent 95d72eb commit 83effbc
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 30 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,9 @@ jobs:
with:
python-version: 3.11

- name: Build docs
run: make html

- name: Build docs
run: make multiversion

Expand Down
14 changes: 11 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ clean-all: clean
# checkout the repos inside repos/ dir
repos:
mkdir repos
mkdir -p subdocs

# build directory paths in repos/* to perform 'git clone <repo>' into
CHECKOUT_REPOS = $(foreach repo,$(OTHER_REPO_DOCS),repos/$(repo))
Expand Down Expand Up @@ -107,9 +108,16 @@ prep: | $(OTHER_REPO_DOCS)

# build multiple versions
multiversion: $(VENV_NAME) Makefile | prep $(OTHER_REPO_DOCS)
source $</bin/activate ; set -u ;\
sphinx-multiversion "$(SOURCEDIR)" "$(BUILDDIR)/multiversion" $(SPHINXOPTS)
cp "$(SOURCEDIR)/_templates/meta_refresh.html" "$(BUILDDIR)/multiversion/index.html"
# source $</bin/activate ; set -u ;\
# sphinx-multiversion "$(SOURCEDIR)" "$(BUILDDIR)/multiversion" $(SPHINXOPTS)
# cp "$(SOURCEDIR)/_templates/meta_refresh.html" "$(BUILDDIR)/multiversion/index.html"
for i in $$(ls -d $(BUILDDIR)/multiversion/*/); \
do \
for j in $$(echo $(OTHER_REPO_DOCS)); \
do \
cp -R $$j $$i; \
done; \
done

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def get_version():
# needs_sphinx = '1.0'

# make all warnings errors
warning_is_error = True
warning_is_error = False

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down
16 changes: 8 additions & 8 deletions hw_install_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Hardware Installation
:hidden:
:caption: Hardware Installation

sdran-in-a-box/docs/HW_Installation_intro
sdran-in-a-box/docs/HW_Installation_prereq
sdran-in-a-box/docs/HW_Installation_omec
sdran-in-a-box/docs/HW_Installation_ric
sdran-in-a-box/docs/HW_Installation_oai_enb
sdran-in-a-box/docs/HW_Installation_oai_ue
sdran-in-a-box/docs/HW_Installation_ops
sdran-in-a-box/docs/HW_Installation_troubleshooting
subdocs/sdran-in-a-box/docs/HW_Installation_intro
subdocs/sdran-in-a-box/docs/HW_Installation_prereq
subdocs/sdran-in-a-box/docs/HW_Installation_omec
subdocs/sdran-in-a-box/docs/HW_Installation_ric
subdocs/sdran-in-a-box/docs/HW_Installation_oai_enb
subdocs/sdran-in-a-box/docs/HW_Installation_oai_ue
subdocs/sdran-in-a-box/docs/HW_Installation_ops
subdocs/sdran-in-a-box/docs/HW_Installation_troubleshooting

36 changes: 18 additions & 18 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,24 @@ can be found on the `ONF Wiki <https://wiki.opennetworking.org/>`_.
:hidden:
:caption: Components

repos/onos-api/README
repos/onos-ric-sdk-go/README
repos/onos-operator/README
repos/onos-e2t/README
repos/onos-a1t/README
repos/onos-e2-sm/README
repos/onos-kpimon/README
repos/onos-pci/README
repos/onos-config/README
repos/onos-topo/README
repos/onos-uenib/README
repos/onos-proxy/README
repos/onos-cli/README
repos/onos-exporter/README
repos/onos-mlb/README
repos/onos-mho/README
repos/onos-rsm/README
repos/ran-simulator/README
subdocs/onos-api/README
subdocs/onos-ric-sdk-go/README
subdocs/onos-operator/README
subdocs/onos-e2t/README
subdocs/onos-a1t/README
subdocs/onos-e2-sm/README
subdocs/onos-kpimon/README
subdocs/onos-pci/README
subdocs/onos-config/README
subdocs/onos-topo/README
subdocs/onos-uenib/README
subdocs/onos-proxy/README
subdocs/onos-cli/README
subdocs/onos-exporter/README
subdocs/onos-mlb/README
subdocs/onos-mho/README
subdocs/onos-rsm/README
subdocs/ran-simulator/README
oai_cu_cp

.. toctree::
Expand Down

0 comments on commit 83effbc

Please sign in to comment.