Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add autobuild and serving for docs #442

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

JacobCoffee
Copy link
Member

@JacobCoffee JacobCoffee commented Aug 2, 2024

Description

  • Adds sphinx-autobuild to build and serve the documentation
    • This will also watch docs/ and auto-rebuild anytime there is a content change
  • Adds a top level Makefile with targets to install docs deps and serve the docs via make docs-serve

Preview

psf-salt on  #364 [📝++(1)🤷] via  pyenv via ⍱ v2.4.1 
󰂃 7% ✗make docs-serve
=> Cleaning documentation build assets
=> Removed existing documentation build assets
=> Installing documentation dependencies
Audited 5 packages in 24ms
=> Installed documentation dependencies
=> Serving documentation
[sphinx-autobuild] Starting initial build
[sphinx-autobuild] > sphinx-build docs/ docs/_build/ -j auto
Running Sphinx v7.3.7
myst v3.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 16 source files that are out of date
updating environment: [new config] 16 added, 0 changed, 0 removed
reading sources... [100%] ssl
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] ssl
generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in docs/_build.
[sphinx-autobuild] Serving on http://127.0.0.1:8000
[sphinx-autobuild] Waiting to detect changes...

Closes

@JacobCoffee JacobCoffee requested a review from ewdurbin as a code owner August 2, 2024 16:17
@ewdurbin
Copy link
Member

ewdurbin commented Aug 6, 2024

I like this. Thoughts on running it via docker so we don't have to do local installation?

@JacobCoffee
Copy link
Member Author

@ewdurbin that sounds okay with me. I've not done it this way before but ill take a jab at it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Make previewing in development easier
2 participants