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

Rearrangement and Toctree updates #1200

Open
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

Smartmind12
Copy link
Contributor

The auto_examples folder did not exist and examples folder was outside the docs folder hence error of 404 arose due to error in toctree links in the docs folder. Hence i first uploaded the examples folder in the docs folder for toctree to work and then updated all the links of toctrees as per desired pathway.
Closes flyteorg/flyte#4109

Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
Signed-off-by: Utsav Paul <[email protected]>
@samhita-alla
Copy link
Contributor

I don't think we should be doing this. @cosmicBboy, I'd like to know your thoughts.

@Smartmind12, can we make this work without disrupting the docs structure?

@Smartmind12
Copy link
Contributor Author

I don't think we should be doing this. @cosmicBboy, I'd like to know your thoughts.

@Smartmind12, can we make this work without disrupting the docs structure?

I researched alot and found that toctree works only if all files and folders are in one master folder which in this case is the docs folder.

I am unaware another method that uses toctree but can refernce different master folders.

In case we remove the toctree system and update the method of the edit then possibly we can do it without changing the structure.

@samhita-alla
Copy link
Contributor

@Smartmind12, looks like the github url can be configured: https://stackoverflow.com/a/66238784

@cosmicBboy
Copy link
Contributor

@samhita-alla @Smartmind12 apologies for not giving feedback earlier. So the current state is by design. The contents of the examples folder are "transpiled" into myst markdown and written to docs/auto_examples as part of the auto_examples sphinx extension.

We need to customize the linking of the edit button instead of moving these files into docs. An example of this can be found in flyteorg's fork of furo.

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.

[BUG] Edit this page links are not working for Flyte Documentation
3 participants