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

Redoc page rendering only when used in toctree directive. #43

Open
sachin-suresh-rapyuta opened this issue Jan 24, 2023 · 0 comments
Open

Comments

@sachin-suresh-rapyuta
Copy link

sachin-suresh-rapyuta commented Jan 24, 2023

Unable to render the page when used in more than one place and without a directive.

I have defined like:

redoc = [
    {
        'name': 'File Upload APIs',
        'page': 'spec/file_upload_apis',
        'spec': 'yaml_spec/openapi.yaml',
        'embed': True,
    }
]
  1. The spec/file_upload_apis.rst is the placeholder file where I want the Redoc API documentation to be rendered.
  2. The hyperlink to the above page looks like:

spec/pa_amr_apis.rst

.. toctree::
   :maxdepth: 5       

   file_upload_apis      //This works when used in toctree directive


file_upload_apis        // This does not work anywhere outside toctree directive

Should I have to use file_upload_apis only within some directive? And not on any page were I want ?

@sachin-suresh-rapyuta sachin-suresh-rapyuta changed the title Redoc page not rendered if used without directive. Redoc page rendering only in toctree directive. Jan 25, 2023
@sachin-suresh-rapyuta sachin-suresh-rapyuta changed the title Redoc page rendering only in toctree directive. Redoc page rendering only when used in toctree directive. Jan 25, 2023
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

No branches or pull requests

1 participant