Skip to content

Commit

Permalink
DOC: Add changelog to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
HaoZeke committed Feb 11, 2024
1 parent fbacdac commit 48fd2d2
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -162,3 +162,5 @@ cython_debug/
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
.pdm-python
/docs/source/CHANGELOG.md
/docs/html/
1 change: 1 addition & 0 deletions changelog.d/38.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`asv_runner` now uses `towncrier` to manage the changelog, also adds the changeglog to the generated documentation.
11 changes: 11 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,14 @@
"source_branch": "main",
"source_directory": "docs/",
}


# ------------- Copying things
import os
import shutil

docs_source_dir = os.path.abspath(os.path.dirname(__file__))
project_root_dir = os.path.abspath(os.path.join(docs_source_dir, '..', '..'))
changelog_src = os.path.join(project_root_dir, 'CHANGELOG.md')
changelog_dest = os.path.join(docs_source_dir, 'CHANGELOG.md')
shutil.copyfile(changelog_src, changelog_dest)
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ measure and analyze the performance of your Python packages.
apidocs/index
bplugin-list
CHANGELOG
```

## Indices and tables
Expand Down

0 comments on commit 48fd2d2

Please sign in to comment.