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

Add sphinx to the documentation section #319

Closed

Conversation

FrostyX
Copy link
Contributor

@FrostyX FrostyX commented Jul 7, 2019

Sphinx is already described under tech/languages/python/sphinx,
but IMHO it should be available even through documentation/sphinx.

There is a question, how to do it. YAML section property is only
string not list, but even then, the file structure wouldn't
correspond. Copy-pasting is just bad and relative_import macro
doesn't support ../ path.

Therefore I've created sphinx_content.md file and symlinked it,
so it is available for both

tech/languages/python/sphinx.md
start/tips/documentation/sphinx.md

Sphinx is already described under tech/languages/python/sphinx,
but IMHO it should be available even through documentation/sphinx.

There is a question, how to do it. YAML `section` property is only
string not list, but even then, the file structure wouldn't
correspond. Copy-pasting is just bad and `relative_import` macro
doesn't support ../ path.

Therefore I've created `sphinx_content.md` file and symlinked it,
so it is available for both

    tech/languages/python/sphinx.md
    start/tips/documentation/sphinx.md
@pvalena
Copy link
Contributor

pvalena commented Jul 16, 2019

Good Idea, but symlinks in Jekyll have to be created differently.
Definitely not:

 /home/jkadlcik/git/fedora-developer-portal/website/content/tech/languages/python/sphinx_content.md 

Please keep one page, and symlink the other(explained in this Issue).

@pvalena
Copy link
Contributor

pvalena commented Jul 16, 2019

Please make appropriate changes.

@pvalena
Copy link
Contributor

pvalena commented Feb 14, 2020

Please give it a look, so we can merge it (it does not have to be perfect, just give it a byte of love).


Note: The release will be soon (~1-2weeks), and after that there will be maintenance (decomissioning) of the release infrastucture(no updates for some time). The website updates still need some manual handling, but openshift will change that.

@pvalena pvalena assigned jackorp and unassigned FrostyX Jun 2, 2021
@jackorp
Copy link
Contributor

jackorp commented Jun 11, 2021

Ping... @FrostyX Are you still interested in advancing with this PR?

@FrostyX
Copy link
Contributor Author

FrostyX commented Jun 11, 2021

Sorry guys for keeping the PR hanging here. I am closing since I don't have the time to finish it now.

@FrostyX FrostyX closed this Jun 11, 2021
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.

3 participants