Skip to content

Commit

Permalink
TRON-2186: Fix docs build on latest release (#963)
Browse files Browse the repository at this point in the history
* chore: Update Makefile to fix path for manual pages

* Fixes changelog in docs to point to latest release. Removes CHANGELOG.md as it has not been updated in years

* fixes docs

* Adds minimal requirements for auto-generated api docs

* Adds generated docs to index.rst

* Removes the _build from git as this should've been part of .gitignore but was accidentally commited after moving to source/

* chore: Update tox.ini to use requirements.txt instead of requirements-minimal.txt

* fixes inconsistent dependencies between docs and requirements.txt

* pin both to 2.13.0 to pass tests

* Ignore generated doc files in git
  • Loading branch information
bobokun committed May 14, 2024
1 parent d9df65b commit 7178ded
Show file tree
Hide file tree
Showing 135 changed files with 17 additions and 20,421 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ tron.egg-info
*.swp
*.swo
docs/_build/
docs/source/generated
.idea
.vscode
tron.iml
Expand Down
956 changes: 0 additions & 956 deletions CHANGELOG.md

This file was deleted.

4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ docs:
tox -r -e docs

man:
which $(SPHINXBUILD) >/dev/null && $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCS_DIR) $(DOCS_DIR)/man || true
which $(SPHINXBUILD) >/dev/null && $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCS_DIR) $(DOCS_DIR)/source/man || true
@echo
@echo "Build finished. The manual pages are in $(DOCS_BUILDDIR)/man."
@echo "Build finished. The manual pages are in $(DOCS_BUILDDIR)/source/man."

clean:
rm -rf tronweb/js/cs
Expand Down
Binary file removed docs/source/_build/command_context.doctree
Binary file not shown.
Binary file removed docs/source/_build/config.doctree
Binary file not shown.
Binary file removed docs/source/_build/developing.doctree
Binary file not shown.
Binary file removed docs/source/_build/environment.pickle
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/source/_build/html/.buildinfo

This file was deleted.

123 changes: 0 additions & 123 deletions docs/source/_build/html/_sources/command_context.rst.txt

This file was deleted.

0 comments on commit 7178ded

Please sign in to comment.