Skip to content

Commit

Permalink
Fixed sphinx doc build
Browse files Browse the repository at this point in the history
* added get_version which reads from `git describe`
* fixed lang conf
  • Loading branch information
dzanotelli committed Jan 2, 2024
1 parent 341a0e5 commit f1472b7
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 7 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [2024-01-02] 1.0.4
- shpinx: fix conf.py, was still using old `get_version` function

## [2024-01-02] 1.0.3
- docs: added docs own `requirements.txt` with sphinx rtd theme (#19)
- build: now build automatically reads the current git tag, instead of relying
Expand Down
20 changes: 13 additions & 7 deletions drypy/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,17 @@
#
import os
import sys

from datetime import datetime
from subprocess import check_output


sys.path.insert(0, os.path.abspath('../..'))

import drypy

def get_version():
return check_output(['git', 'describe',]).decode('ascii').strip()


# -- General configuration ------------------------------------------------

Expand Down Expand Up @@ -53,24 +61,22 @@

# General information about the project.
project = 'drypy'
copyright = '2017-2020, Daniele Zanotelli'
copyright = f'2017-{datetime.now().year}, Daniele Zanotelli'
author = 'Daniele Zanotelli'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = drypy.get_version(short=True)
# The full version, including alpha/beta/rc tags.
release = drypy.get_version()
version = get_version()
release = get_version()

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# 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

0 comments on commit f1472b7

Please sign in to comment.