Skip to content

Updated Documentation to DocGuide V1 Standards#715

Open
RogerJanusiak wants to merge 9 commits intomasterfrom
documentation_updates
Open

Updated Documentation to DocGuide V1 Standards#715
RogerJanusiak wants to merge 9 commits intomasterfrom
documentation_updates

Conversation

@RogerJanusiak
Copy link
Contributor

Using the DocGuide Standards that I created here:

https://github.com/ssl-hep/ServiceX_Website/blob/main/DocGuide.md

I updated the documentation to match. This includes:

  1. Moving all files from .rst to .md
  2. Restructuring and cleaning up directories.
  3. Adding navigation bar to the documentation to allow for integration into website
  4. Updating readme
  5. Removing pages that are redundant or will be redundant with the website.
  6. Cleaning up warnings at build time.

First step towards closing issue #709 .

@RogerJanusiak RogerJanusiak self-assigned this Feb 10, 2026
@RogerJanusiak RogerJanusiak added the documentation Improvements or additions to documentation label Feb 10, 2026
@codecov
Copy link

codecov bot commented Feb 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.35%. Comparing base (df3d0b7) to head (44b678d).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #715   +/-   ##
=======================================
  Coverage   98.35%   98.35%           
=======================================
  Files          30       30           
  Lines        2190     2190           
=======================================
  Hits         2154     2154           
  Misses         36       36           
Flag Coverage Δ
unittests 98.35% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@BenGalewsky
Copy link
Contributor

How do I test this? Is this now published somewhere?
How do I locally build the docs?

How do we ensure that when a doc update is made in this repo the docs on tryservicex.org are updated?

@RogerJanusiak
Copy link
Contributor Author

@BenGalewsky You must build the docs locally. I will add instructions to this doc:

https://github.com/ssl-hep/ServiceX_Website/blob/main/DocGuide.md

But until then, you need to install all of the doc stuff into a venv. Navigate to the directory with the make files and source/. Then you can run this command sphinx-build -a -E source build. This creates a build directory and you right click on the index.html and click open live server (must have this plugin installed in vscode).

On the auto updating the website, this feature cannot be added until all of the docs are moved to the new file structure. Then I will be able to edit the workflows to allow for this. But I think this step should be done first. Then I can build another PR to auto update the website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

2 participants