Skip to content

Add initial Sphinx documentation setup with MyST support.#145

Open
Phanindra899 wants to merge 6 commits intoapache:masterfrom
Phanindra899:sphinx-docs-setup
Open

Add initial Sphinx documentation setup with MyST support.#145
Phanindra899 wants to merge 6 commits intoapache:masterfrom
Phanindra899:sphinx-docs-setup

Conversation

@Phanindra899
Copy link
Copy Markdown

This PR introduces an initial Sphinx-based documentation setup for Apache Otava.

Key points:

  • Adds a basic Sphinx structure under docs_sphinx/
  • Enables MyST parser to support existing Markdown documentation
  • Demonstrates integration by including current docs in the Sphinx build

The documentation builds successfully without errors. Minor adjustments were made to ensure compatibility with Sphinx (e.g., resolving internal links and formatting issues).

The goal of this PR is to establish a minimal working foundation for adopting Sphinx without requiring a full migration. Further improvements (e.g., refining cross-references or example paths) can be done incrementally.

There are still some warnings related to cross-references and example paths, which can be addressed in follow-up PRs to keep this change focused and incremental.

@Phanindra899
Copy link
Copy Markdown
Author

Phanindra899 commented Mar 30, 2026

Hi , I’ve implemented an initial Sphinx setup for the documentation with MyST support.

The docs build successfully, and I focused on creating a minimal working structure rather than doing a full migration in one step.

Could you please review if this aligns with the intended direction? I’d be happy to iterate further or refine specific parts based on your feedback.

@Phanindra899
Copy link
Copy Markdown
Author

Hi! I noticed that the GitHub Actions workflow didn’t run due to fork security restrictions.

Could someone please review and approve the workflow so the checks can run?

Thanks!

Copy link
Copy Markdown
Contributor

@henrikingo henrikingo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't you just use the docs/ directory directly? This approach would leave us with two copies of the markdown files. That is typically the start of a messy situation.

Welcome to Apache Otava Documentation
=====================================

This documentation is powered by Sphinx and supports Markdown via MyST.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would IMO fit better at the very end of this page.

@@ -0,0 +1,35 @@
@ECHO OFF
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I assume you use Windows? In principle there is no reason to discriminate based on any operating system... But in practice having any part of the build chain using windows BAT files is not going to work, as none of the existing developers could do anything with it.

Are you able to use the Windows Subsystem for Linux? (Despite its name, it really is Linux compatible packages for Windows...) Could you write this same file in SHELL or BASH?

Alternatively you could write this as a python script.

@Phanindra899
Copy link
Copy Markdown
Author

Hi @henrikingo,

Thanks for the detailed feedback.

I've now updated the PR to:

  • Remove duplicated markdown files and use docs/ as the single source of truth
  • Update index.rst to reference documentation directly from docs/
  • Clean up the Sphinx configuration and ensure proper structure
  • Move the Sphinx description text to the end as suggested

Please let me know if this looks correct now.

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.

2 participants