Skip to content

Commit

Permalink
Set language, remove missing class, and update docs dependency versio…
Browse files Browse the repository at this point in the history
…ns for 3.12
  • Loading branch information
adamnovak committed Oct 15, 2024
1 parent 73e126a commit 21dd9b2
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ build:
python: "3.12"
apt_packages:
- libjansson-dev
- cmake

# Build documentation in the bdsg/docs/ directory with Sphinx
sphinx:
Expand Down
7 changes: 5 additions & 2 deletions bdsg/docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,15 @@ help:
# So we link it to something predictable.
# Also make sure the CMake build will run Doxygen for us.
../../lib/bdsg.module:
cd ../.. && mkdir -p build && cd build && cmake .. -DPYTHON_EXECUTABLE=$(shell which python3) -DRUN_DOXYGEN=ON && $(MAKE)
cd ../.. && rm -f lib/bdsg.cpython-*.*
cd ../.. && mkdir -p build
cd ../../build && cmake .. -DPYTHON_EXECUTABLE=$(shell which python3) -DRUN_DOXYGEN=ON
cd ../../build && $(MAKE)
cd ../.. && ln lib/bdsg.cpython-*.* lib/bdsg.module

# Make sure we are ready to run Sphinx
sphinxprep: ../../lib/bdsg.module
python3 -c 'import sphinx ; import breathe' || pip3 install -r requirements.txt --use-feature=2020-resolver
python3 -c 'import sphinx ; import breathe' || pip install -r requirements.txt

clean:
rm -Rf $(BUILDDIR)
Expand Down
4 changes: 2 additions & 2 deletions bdsg/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down Expand Up @@ -116,7 +116,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = []

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down
4 changes: 2 additions & 2 deletions bdsg/docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ packaging==20.4
Pygments==2.7.2
pyparsing==2.4.7
pytz==2020.1
requests==2.24.0
requests==2.32.3
six==1.15.0
snowballstemmer==2.0.0
Sphinx==5.1.1
Expand All @@ -24,5 +24,5 @@ sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-websupport==1.2.4
urllib3==1.25.11
urllib3==2.2.3

3 changes: 0 additions & 3 deletions bdsg/docs/rst/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -235,9 +235,6 @@ Here is an example of how to use these typed collections:
.. autoclass:: vector_handlegraph_handle_t
:members:

.. autoclass:: vector_handlegraph_path_handle_t
:members:

.. autoclass:: vector_handlegraph_step_handle_t
:members:

Expand Down

0 comments on commit 21dd9b2

Please sign in to comment.